September 26, 2024: PostgreSQL 17 Released!
Unsupported versions: 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4 / 7.3 / 7.2 / 7.1
This documentation is for an unsupported version of PostgreSQL.
You may want to view the same page for the current version, or one of the other supported versions listed above instead.

createlang

Name

createlang -- define a new PostgreSQL procedural language

Synopsis

createlang [connection-option...] langname [dbname]
createlang [connection-option...] --list | -l dbname

Description

createlang is a utility for adding a new programming language to a PostgreSQL database. createlang is just a wrapper around the CREATE LANGUAGE command.

Options

createlang accepts the following command-line arguments:

langname

Specifies the name of the procedural programming language to be defined.

[-d] dbname
[--dbname] dbname

Specifies to which database the language should be added. The default is to use the database with the same name as the current system user.

-e
--echo

Display SQL commands as they are executed.

-l
--list

Show a list of already installed languages in the target database.

createlang also accepts the following command-line arguments for connection parameters:

-h host
--host host

Specifies the host name of the machine on which the server is running. If the value begins with a slash, it is used as the directory for the Unix domain socket.

-p port
--port port

Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections.

-U username
--username username

User name to connect as.

-W
--password

Force password prompt.

Environment

PGDATABASE
PGHOST
PGPORT
PGUSER

Default connection parameters

This utility, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section 29.12).

Diagnostics

Most error messages are self-explanatory. If not, run createlang with the --echo option and see under the respective SQL command for details. Also, any default connection settings and environment variables used by the libpq front-end library will apply.

Notes

Use droplang to remove a language.

Examples

To install the language pltcl into the database template1:

$ createlang pltcl template1

Note that installing the language into template1 will cause it to be automatically installed into subsequently-created databases as well.