PostgreSQL Source Code  git master
createdb.c
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * createdb
4  *
5  * Portions Copyright (c) 1996-2022, PostgreSQL Global Development Group
6  * Portions Copyright (c) 1994, Regents of the University of California
7  *
8  * src/bin/scripts/createdb.c
9  *
10  *-------------------------------------------------------------------------
11  */
12 #include "postgres_fe.h"
13 
14 #include "common.h"
15 #include "common/logging.h"
16 #include "fe_utils/option_utils.h"
17 #include "fe_utils/string_utils.h"
18 
19 
20 static void help(const char *progname);
21 
22 
23 int
24 main(int argc, char *argv[])
25 {
26  static struct option long_options[] = {
27  {"host", required_argument, NULL, 'h'},
28  {"port", required_argument, NULL, 'p'},
29  {"username", required_argument, NULL, 'U'},
30  {"no-password", no_argument, NULL, 'w'},
31  {"password", no_argument, NULL, 'W'},
32  {"echo", no_argument, NULL, 'e'},
33  {"owner", required_argument, NULL, 'O'},
34  {"tablespace", required_argument, NULL, 'D'},
35  {"template", required_argument, NULL, 'T'},
36  {"encoding", required_argument, NULL, 'E'},
37  {"strategy", required_argument, NULL, 'S'},
38  {"lc-collate", required_argument, NULL, 1},
39  {"lc-ctype", required_argument, NULL, 2},
40  {"locale", required_argument, NULL, 'l'},
41  {"maintenance-db", required_argument, NULL, 3},
42  {"locale-provider", required_argument, NULL, 4},
43  {"icu-locale", required_argument, NULL, 5},
44  {NULL, 0, NULL, 0}
45  };
46 
47  const char *progname;
48  int optindex;
49  int c;
50 
51  const char *dbname = NULL;
52  const char *maintenance_db = NULL;
53  char *comment = NULL;
54  char *host = NULL;
55  char *port = NULL;
56  char *username = NULL;
57  enum trivalue prompt_password = TRI_DEFAULT;
58  ConnParams cparams;
59  bool echo = false;
60  char *owner = NULL;
61  char *tablespace = NULL;
62  char *template = NULL;
63  char *encoding = NULL;
64  char *strategy = NULL;
65  char *lc_collate = NULL;
66  char *lc_ctype = NULL;
67  char *locale = NULL;
68  char *locale_provider = NULL;
69  char *icu_locale = NULL;
70 
71  PQExpBufferData sql;
72 
73  PGconn *conn;
74  PGresult *result;
75 
76  pg_logging_init(argv[0]);
77  progname = get_progname(argv[0]);
78  set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pgscripts"));
79 
80  handle_help_version_opts(argc, argv, "createdb", help);
81 
82  while ((c = getopt_long(argc, argv, "h:p:U:wWeO:D:T:E:l:S:", long_options, &optindex)) != -1)
83  {
84  switch (c)
85  {
86  case 'h':
87  host = pg_strdup(optarg);
88  break;
89  case 'p':
91  break;
92  case 'U':
94  break;
95  case 'w':
96  prompt_password = TRI_NO;
97  break;
98  case 'W':
99  prompt_password = TRI_YES;
100  break;
101  case 'e':
102  echo = true;
103  break;
104  case 'O':
105  owner = pg_strdup(optarg);
106  break;
107  case 'D':
109  break;
110  case 'T':
111  template = pg_strdup(optarg);
112  break;
113  case 'E':
115  break;
116  case 'S':
117  strategy = pg_strdup(optarg);
118  break;
119  case 1:
121  break;
122  case 2:
124  break;
125  case 'l':
127  break;
128  case 3:
129  maintenance_db = pg_strdup(optarg);
130  break;
131  case 4:
133  break;
134  case 5:
136  break;
137  default:
138  /* getopt_long already emitted a complaint */
139  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
140  exit(1);
141  }
142  }
143 
144  switch (argc - optind)
145  {
146  case 0:
147  break;
148  case 1:
149  dbname = argv[optind];
150  break;
151  case 2:
152  dbname = argv[optind];
153  comment = argv[optind + 1];
154  break;
155  default:
156  pg_log_error("too many command-line arguments (first is \"%s\")",
157  argv[optind + 2]);
158  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
159  exit(1);
160  }
161 
162  if (locale)
163  {
164  if (lc_ctype)
165  pg_fatal("only one of --locale and --lc-ctype can be specified");
166  if (lc_collate)
167  pg_fatal("only one of --locale and --lc-collate can be specified");
168  lc_ctype = locale;
169  lc_collate = locale;
170  }
171 
172  if (encoding)
173  {
174  if (pg_char_to_encoding(encoding) < 0)
175  pg_fatal("\"%s\" is not a valid encoding name", encoding);
176  }
177 
178  if (dbname == NULL)
179  {
180  if (getenv("PGDATABASE"))
181  dbname = getenv("PGDATABASE");
182  else if (getenv("PGUSER"))
183  dbname = getenv("PGUSER");
184  else
186  }
187 
188  /* No point in trying to use postgres db when creating postgres db. */
189  if (maintenance_db == NULL && strcmp(dbname, "postgres") == 0)
190  maintenance_db = "template1";
191 
192  cparams.dbname = maintenance_db;
193  cparams.pghost = host;
194  cparams.pgport = port;
195  cparams.pguser = username;
196  cparams.prompt_password = prompt_password;
197  cparams.override_dbname = NULL;
198 
199  conn = connectMaintenanceDatabase(&cparams, progname, echo);
200 
201  initPQExpBuffer(&sql);
202 
203  appendPQExpBuffer(&sql, "CREATE DATABASE %s",
204  fmtId(dbname));
205 
206  if (owner)
207  appendPQExpBuffer(&sql, " OWNER %s", fmtId(owner));
208  if (tablespace)
209  appendPQExpBuffer(&sql, " TABLESPACE %s", fmtId(tablespace));
210  if (encoding)
211  {
212  appendPQExpBufferStr(&sql, " ENCODING ");
214  }
215  if (strategy)
216  appendPQExpBuffer(&sql, " STRATEGY %s", fmtId(strategy));
217  if (template)
218  appendPQExpBuffer(&sql, " TEMPLATE %s", fmtId(template));
219  if (lc_collate)
220  {
221  appendPQExpBufferStr(&sql, " LC_COLLATE ");
223  }
224  if (lc_ctype)
225  {
226  appendPQExpBufferStr(&sql, " LC_CTYPE ");
228  }
229  if (locale_provider)
230  appendPQExpBuffer(&sql, " LOCALE_PROVIDER %s", locale_provider);
231  if (icu_locale)
232  {
233  appendPQExpBufferStr(&sql, " ICU_LOCALE ");
235  }
236 
237  appendPQExpBufferChar(&sql, ';');
238 
239  if (echo)
240  printf("%s\n", sql.data);
241  result = PQexec(conn, sql.data);
242 
243  if (PQresultStatus(result) != PGRES_COMMAND_OK)
244  {
245  pg_log_error("database creation failed: %s", PQerrorMessage(conn));
246  PQfinish(conn);
247  exit(1);
248  }
249 
250  PQclear(result);
251 
252  if (comment)
253  {
254  printfPQExpBuffer(&sql, "COMMENT ON DATABASE %s IS ", fmtId(dbname));
255  appendStringLiteralConn(&sql, comment, conn);
256  appendPQExpBufferChar(&sql, ';');
257 
258  if (echo)
259  printf("%s\n", sql.data);
260  result = PQexec(conn, sql.data);
261 
262  if (PQresultStatus(result) != PGRES_COMMAND_OK)
263  {
264  pg_log_error("comment creation failed (database was created): %s",
266  PQfinish(conn);
267  exit(1);
268  }
269 
270  PQclear(result);
271  }
272 
273  PQfinish(conn);
274 
275  exit(0);
276 }
277 
278 
279 static void
280 help(const char *progname)
281 {
282  printf(_("%s creates a PostgreSQL database.\n\n"), progname);
283  printf(_("Usage:\n"));
284  printf(_(" %s [OPTION]... [DBNAME] [DESCRIPTION]\n"), progname);
285  printf(_("\nOptions:\n"));
286  printf(_(" -D, --tablespace=TABLESPACE default tablespace for the database\n"));
287  printf(_(" -e, --echo show the commands being sent to the server\n"));
288  printf(_(" -E, --encoding=ENCODING encoding for the database\n"));
289  printf(_(" -l, --locale=LOCALE locale settings for the database\n"));
290  printf(_(" --lc-collate=LOCALE LC_COLLATE setting for the database\n"));
291  printf(_(" --lc-ctype=LOCALE LC_CTYPE setting for the database\n"));
292  printf(_(" --icu-locale=LOCALE ICU locale setting for the database\n"));
293  printf(_(" --locale-provider={libc|icu}\n"
294  " locale provider for the database's default collation\n"));
295  printf(_(" -O, --owner=OWNER database user to own the new database\n"));
296  printf(_(" -S, --strategy=STRATEGY database creation strategy wal_log or file_copy\n"));
297  printf(_(" -T, --template=TEMPLATE template database to copy\n"));
298  printf(_(" -V, --version output version information, then exit\n"));
299  printf(_(" -?, --help show this help, then exit\n"));
300  printf(_("\nConnection options:\n"));
301  printf(_(" -h, --host=HOSTNAME database server host or socket directory\n"));
302  printf(_(" -p, --port=PORT database server port\n"));
303  printf(_(" -U, --username=USERNAME user name to connect as\n"));
304  printf(_(" -w, --no-password never prompt for password\n"));
305  printf(_(" -W, --password force password prompt\n"));
306  printf(_(" --maintenance-db=DBNAME alternate maintenance database\n"));
307  printf(_("\nBy default, a database with the same name as the current user is created.\n"));
308  printf(_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
309  printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL);
310 }
#define PG_TEXTDOMAIN(domain)
Definition: c.h:1212
void set_pglocale_pgservice(const char *argv0, const char *app)
Definition: exec.c:446
PGconn * connectMaintenanceDatabase(ConnParams *cparams, const char *progname, bool echo)
int main(int argc, char *argv[])
Definition: createdb.c:24
static void help(const char *progname)
Definition: createdb.c:280
#define _(x)
Definition: elog.c:89
int pg_char_to_encoding(const char *name)
Definition: encnames.c:550
char * PQerrorMessage(const PGconn *conn)
Definition: fe-connect.c:6908
void PQfinish(PGconn *conn)
Definition: fe-connect.c:4261
ExecStatusType PQresultStatus(const PGresult *res)
Definition: fe-exec.c:3270
void PQclear(PGresult *res)
Definition: fe-exec.c:718
PGresult * PQexec(PGconn *conn, const char *query)
Definition: fe-exec.c:2273
char * pg_strdup(const char *in)
Definition: fe_memutils.c:85
int getopt_long(int argc, char *const argv[], const char *optstring, const struct option *longopts, int *longindex)
Definition: getopt_long.c:57
#define no_argument
Definition: getopt_long.h:24
#define required_argument
Definition: getopt_long.h:25
static char * lc_collate
Definition: initdb.c:129
static char * lc_ctype
Definition: initdb.c:130
static char locale_provider
Definition: initdb.c:135
static char * locale
Definition: initdb.c:128
static char * icu_locale
Definition: initdb.c:136
@ PGRES_COMMAND_OK
Definition: libpq-fe.h:97
exit(1)
void pg_logging_init(const char *argv0)
Definition: logging.c:83
#define pg_log_error(...)
Definition: logging.h:106
#define pg_log_error_hint(...)
Definition: logging.h:112
const char * progname
Definition: main.c:50
void handle_help_version_opts(int argc, char *argv[], const char *fixed_progname, help_handler hlp)
Definition: option_utils.c:24
#define pg_fatal(...)
int32 encoding
Definition: pg_database.h:41
PGDLLIMPORT int optind
Definition: getopt.c:50
PGDLLIMPORT char * optarg
Definition: getopt.c:52
static int port
Definition: pg_regress.c:92
const char * username
Definition: pgbench.c:309
char * tablespace
Definition: pgbench.c:229
const char * get_progname(const char *argv0)
Definition: path.c:574
#define printf(...)
Definition: port.h:231
void printfPQExpBuffer(PQExpBuffer str, const char *fmt,...)
Definition: pqexpbuffer.c:237
void initPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:92
void appendPQExpBuffer(PQExpBuffer str, const char *fmt,...)
Definition: pqexpbuffer.c:267
void appendPQExpBufferChar(PQExpBuffer str, char ch)
Definition: pqexpbuffer.c:380
void appendPQExpBufferStr(PQExpBuffer str, const char *data)
Definition: pqexpbuffer.c:369
char * c
char * dbname
Definition: streamutil.c:51
PGconn * conn
Definition: streamutil.c:54
void appendStringLiteralConn(PQExpBuffer buf, const char *str, PGconn *conn)
Definition: string_utils.c:293
const char * fmtId(const char *rawid)
Definition: string_utils.c:64
const char * pguser
Definition: connect_utils.h:31
char * override_dbname
Definition: pg_backup.h:89
char * pgport
Definition: pg_backup.h:83
char * pghost
Definition: pg_backup.h:84
char * dbname
Definition: pg_backup.h:82
enum trivalue prompt_password
Definition: connect_utils.h:32
const char * get_user_name_or_exit(const char *progname)
Definition: username.c:74
trivalue
Definition: vacuumlo.c:35
@ TRI_YES
Definition: vacuumlo.c:38
@ TRI_DEFAULT
Definition: vacuumlo.c:36
@ TRI_NO
Definition: vacuumlo.c:37