createlang(1)

1CREATELANG(1)           PostgreSQL Client Applications           CREATELANG(1)
2
3
4

NAME

6       createlang - define a new PostgreSQL procedural language
7
8

SYNOPSIS

10       createlang [ connection-option... ]  langname  [ dbname ]
11
12       createlang [ connection-option... ]  --list | -l  dbname
13

DESCRIPTION

15       createlang  is  a  utility  for  adding a new programming language to a
16       PostgreSQL database.  createlang is just a wrapper  around  the  CREATE
17       LANGUAGE [create_language(7)] command.
18

OPTIONS

20       createlang accepts the following command-line arguments:
21
22       langname
23              Specifies  the name of the procedural programming language to be
24              defined.
25
26       [-d] dbname
27
28       [--dbname] dbname
29              Specifies to which database the language should be  added.   The
30              default is to use the database with the same name as the current
31              system user.
32
33       -e
34
35       --echo Display SQL commands as they are executed.
36
37       -l
38
39       --list Show a list of already installed languages in the  target  data‐
40              base.
41
42       createlang  also  accepts the following command-line arguments for con‐
43       nection parameters:
44
45       -h host
46
47       --host host
48              Specifies the host name of the machine on which  the  server  is
49              running.  If  the  value  begins with a slash, it is used as the
50              directory for the Unix domain socket.
51
52       -p port
53
54       --port port
55              Specifies the TCP port or local Unix domain socket  file  exten‐
56              sion on which the server is listening for connections.
57
58       -U username
59
60       --username username
61              User name to connect as.
62
63       -w
64
65       --no-password
66              Never  issue  a password prompt. If the server requires password
67              authentication and a password is not available  by  other  means
68              such  as  a .pgpass file, the connection attempt will fail. This
69              option can be useful in batch jobs and scripts where no user  is
70              present to enter a password.
71
72       -W
73
74       --password
75              Force createlang to prompt for a password before connecting to a
76              database.
77
78              This option is never essential, since createlang will  automati‐
79              cally  prompt  for  a  password  if  the server demands password
80              authentication.  However, createlang  will  waste  a  connection
81              attempt  finding  out that the server wants a password.  In some
82              cases it is worth  typing  -W  to  avoid  the  extra  connection
83              attempt.
84

ENVIRONMENT

86       PGDATABASE
87
88       PGHOST
89
90       PGPORT
91
92       PGUSER Default connection parameters
93
94       This utility, like most other PostgreSQL utilities, also uses the envi‐
95       ronment variables supported by libpq (see in the documentation).
96

DIAGNOSTICS

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

NOTES

104       Use droplang(1) to remove a language.
105

EXAMPLES

107       To install the language pltcl into the database template1:
108
109       $ createlang pltcl template1
110
111       Note  that  installing  the language into template1 will cause it to be
112       automatically installed into subsequently-created databases as well.
113