begriffs open source - ai-pg/blob - full-docs/man7/CREATE_EXTENSION.7

   1 '\" t
   2 .\"     Title: CREATE EXTENSION
   3 .\"    Author: The PostgreSQL Global Development Group
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2025
   6 .\"    Manual: PostgreSQL 18.0 Documentation
   7 .\"    Source: PostgreSQL 18.0
   8 .\"  Language: English
   9 .\"
  10 .TH "CREATE EXTENSION" "7" "2025" "PostgreSQL 18.0" "PostgreSQL 18.0 Documentation"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 CREATE_EXTENSION \- install an extension
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 CREATE EXTENSION [ IF NOT EXISTS ] \fIextension_name\fR
  36     [ WITH ] [ SCHEMA \fIschema_name\fR ]
  37              [ VERSION \fIversion\fR ]
  38              [ CASCADE ]
  39 .fi
  40 .SH "DESCRIPTION"
  41 .PP
  42 \fBCREATE EXTENSION\fR
  43 loads a new extension into the current database\&. There must not be an extension of the same name already loaded\&.
  44 .PP
  45 Loading an extension essentially amounts to running the extension\*(Aqs script file\&. The script will typically create new
  46 SQL
  47 objects such as functions, data types, operators and index support methods\&.
  48 \fBCREATE EXTENSION\fR
  49 additionally records the identities of all the created objects, so that they can be dropped again if
  50 \fBDROP EXTENSION\fR
  51 is issued\&.
  52 .PP
  53 The user who runs
  54 \fBCREATE EXTENSION\fR
  55 becomes the owner of the extension for purposes of later privilege checks, and normally also becomes the owner of any objects created by the extension\*(Aqs script\&.
  56 .PP
  57 Loading an extension ordinarily requires the same privileges that would be required to create its component objects\&. For many extensions this means superuser privileges are needed\&. However, if the extension is marked
  58 trusted
  59 in its control file, then it can be installed by any user who has
  60 CREATE
  61 privilege on the current database\&. In this case the extension object itself will be owned by the calling user, but the contained objects will be owned by the bootstrap superuser (unless the extension\*(Aqs script explicitly assigns them to the calling user)\&. This configuration gives the calling user the right to drop the extension, but not to modify individual objects within it\&.
  62 .SH "PARAMETERS"
  63 .PP
  64 IF NOT EXISTS
  65 .RS 4
  66 Do not throw an error if an extension with the same name already exists\&. A notice is issued in this case\&. Note that there is no guarantee that the existing extension is anything like the one that would have been created from the currently\-available script file\&.
  67 .RE
  68 .PP
  69 \fIextension_name\fR
  70 .RS 4
  71 The name of the extension to be installed\&.
  72 PostgreSQL
  73 will create the extension using details from the file
  74 \fIextension_name\fR\&.control, found via the server\*(Aqs extension control path (set by
  75 extension_control_path\&.)
  76 .RE
  77 .PP
  78 \fIschema_name\fR
  79 .RS 4
  80 The name of the schema in which to install the extension\*(Aqs objects, given that the extension allows its contents to be relocated\&. The named schema must already exist\&. If not specified, and the extension\*(Aqs control file does not specify a schema either, the current default object creation schema is used\&.
  81 .sp
  82 If the extension specifies a
  83 schema
  84 parameter in its control file, then that schema cannot be overridden with a
  85 SCHEMA
  86 clause\&. Normally, an error will be raised if a
  87 SCHEMA
  88 clause is given and it conflicts with the extension\*(Aqs
  89 schema
  90 parameter\&. However, if the
  91 CASCADE
  92 clause is also given, then
  93 \fIschema_name\fR
  94 is ignored when it conflicts\&. The given
  95 \fIschema_name\fR
  96 will be used for installation of any needed extensions that do not specify
  97 schema
  98 in their control files\&.
  99 .sp
 100 Remember that the extension itself is not considered to be within any schema: extensions have unqualified names that must be unique database\-wide\&. But objects belonging to the extension can be within schemas\&.
 101 .RE
 102 .PP
 103 \fIversion\fR
 104 .RS 4
 105 The version of the extension to install\&. This can be written as either an identifier or a string literal\&. The default version is whatever is specified in the extension\*(Aqs control file\&.
 106 .RE
 107 .PP
 108 CASCADE
 109 .RS 4
 110 Automatically install any extensions that this extension depends on that are not already installed\&. Their dependencies are likewise automatically installed, recursively\&. The
 111 SCHEMA
 112 clause, if given, applies to all extensions that get installed this way\&. Other options of the statement are not applied to automatically\-installed extensions; in particular, their default versions are always selected\&.
 113 .RE
 114 .SH "NOTES"
 115 .PP
 116 Before you can use
 117 \fBCREATE EXTENSION\fR
 118 to load an extension into a database, the extension\*(Aqs supporting files must be installed\&. Information about installing the extensions supplied with
 119 PostgreSQL
 120 can be found in
 121 Additional Supplied Modules\&.
 122 .PP
 123 The extensions currently available for loading can be identified from the
 124 pg_available_extensions
 125 or
 126 pg_available_extension_versions
 127 system views\&.
 128 .if n \{\
 129 .sp
 130 .\}
 131 .RS 4
 132 .it 1 an-trap
 133 .nr an-no-space-flag 1
 134 .nr an-break-flag 1
 135 .br
 136 .ps +1
 137 \fBCaution\fR
 138 .ps -1
 139 .br
 140 .PP
 141 Installing an extension as superuser requires trusting that the extension\*(Aqs author wrote the extension installation script in a secure fashion\&. It is not terribly difficult for a malicious user to create trojan\-horse objects that will compromise later execution of a carelessly\-written extension script, allowing that user to acquire superuser privileges\&. However, trojan\-horse objects are only hazardous if they are in the
 142 \fIsearch_path\fR
 143 during script execution, meaning that they are in the extension\*(Aqs installation target schema or in the schema of some extension it depends on\&. Therefore, a good rule of thumb when dealing with extensions whose scripts have not been carefully vetted is to install them only into schemas for which CREATE privilege has not been and will not be granted to any untrusted users\&. Likewise for any extensions they depend on\&.
 144 .PP
 145 The extensions supplied with
 146 PostgreSQL
 147 are believed to be secure against installation\-time attacks of this sort, except for a few that depend on other extensions\&. As stated in the documentation for those extensions, they should be installed into secure schemas, or installed into the same schemas as the extensions they depend on, or both\&.
 148 .sp .5v
 149 .RE
 150 .PP
 151 For information about writing new extensions, see
 152 Section\ \&36.17\&.
 153 .SH "EXAMPLES"
 154 .PP
 155 Install the
 156 hstore
 157 extension into the current database, placing its objects in schema
 158 addons:
 159 .sp
 160 .if n \{\
 161 .RS 4
 162 .\}
 163 .nf
 164 CREATE EXTENSION hstore SCHEMA addons;
 165 .fi
 166 .if n \{\
 167 .RE
 168 .\}
 169 .sp
 170 Another way to accomplish the same thing:
 171 .sp
 172 .if n \{\
 173 .RS 4
 174 .\}
 175 .nf
 176 SET search_path = addons;
 177 CREATE EXTENSION hstore;
 178 .fi
 179 .if n \{\
 180 .RE
 181 .\}
 182 .SH "COMPATIBILITY"
 183 .PP
 184 \fBCREATE EXTENSION\fR
 185 is a
 186 PostgreSQL
 187 extension\&.
 188 .SH "SEE ALSO"
 189 ALTER EXTENSION (\fBALTER_EXTENSION\fR(7)), DROP EXTENSION (\fBDROP_EXTENSION\fR(7))