Line data Source code
1 : /*-------------------------------------------------------------------------
2 : *
3 : * createdb
4 : *
5 : * Portions Copyright (c) 1996-2026, 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 0 : 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 : {"builtin-locale", required_argument, NULL, 5},
44 : {"icu-locale", required_argument, NULL, 6},
45 : {"icu-rules", required_argument, NULL, 7},
46 : {NULL, 0, NULL, 0}
47 : };
48 :
49 0 : const char *progname;
50 0 : int optindex;
51 0 : int c;
52 :
53 0 : const char *dbname = NULL;
54 0 : const char *maintenance_db = NULL;
55 0 : char *comment = NULL;
56 0 : char *host = NULL;
57 0 : char *port = NULL;
58 0 : char *username = NULL;
59 0 : enum trivalue prompt_password = TRI_DEFAULT;
60 0 : ConnParams cparams;
61 0 : bool echo = false;
62 0 : char *owner = NULL;
63 0 : char *tablespace = NULL;
64 0 : char *template = NULL;
65 0 : char *encoding = NULL;
66 0 : char *strategy = NULL;
67 0 : char *lc_collate = NULL;
68 0 : char *lc_ctype = NULL;
69 0 : char *locale = NULL;
70 0 : char *locale_provider = NULL;
71 0 : char *builtin_locale = NULL;
72 0 : char *icu_locale = NULL;
73 0 : char *icu_rules = NULL;
74 :
75 0 : PQExpBufferData sql;
76 :
77 0 : PGconn *conn;
78 0 : PGresult *result;
79 :
80 0 : pg_logging_init(argv[0]);
81 0 : progname = get_progname(argv[0]);
82 0 : set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pgscripts"));
83 :
84 0 : handle_help_version_opts(argc, argv, "createdb", help);
85 :
86 0 : while ((c = getopt_long(argc, argv, "D:eE:h:l:O:p:S:T:U:wW", long_options, &optindex)) != -1)
87 : {
88 0 : switch (c)
89 : {
90 : case 'D':
91 0 : tablespace = pg_strdup(optarg);
92 0 : break;
93 : case 'e':
94 0 : echo = true;
95 0 : break;
96 : case 'E':
97 0 : encoding = pg_strdup(optarg);
98 0 : break;
99 : case 'h':
100 0 : host = pg_strdup(optarg);
101 0 : break;
102 : case 'l':
103 0 : locale = pg_strdup(optarg);
104 0 : break;
105 : case 'O':
106 0 : owner = pg_strdup(optarg);
107 0 : break;
108 : case 'p':
109 0 : port = pg_strdup(optarg);
110 0 : break;
111 : case 'S':
112 0 : strategy = pg_strdup(optarg);
113 0 : break;
114 : case 'T':
115 0 : template = pg_strdup(optarg);
116 0 : break;
117 : case 'U':
118 0 : username = pg_strdup(optarg);
119 0 : break;
120 : case 'w':
121 0 : prompt_password = TRI_NO;
122 0 : break;
123 : case 'W':
124 0 : prompt_password = TRI_YES;
125 0 : break;
126 : case 1:
127 0 : lc_collate = pg_strdup(optarg);
128 0 : break;
129 : case 2:
130 0 : lc_ctype = pg_strdup(optarg);
131 0 : break;
132 : case 3:
133 0 : maintenance_db = pg_strdup(optarg);
134 0 : break;
135 : case 4:
136 0 : locale_provider = pg_strdup(optarg);
137 0 : break;
138 : case 5:
139 0 : builtin_locale = pg_strdup(optarg);
140 0 : break;
141 : case 6:
142 0 : icu_locale = pg_strdup(optarg);
143 0 : break;
144 : case 7:
145 0 : icu_rules = pg_strdup(optarg);
146 0 : break;
147 : default:
148 : /* getopt_long already emitted a complaint */
149 0 : pg_log_error_hint("Try \"%s --help\" for more information.", progname);
150 0 : exit(1);
151 : }
152 : }
153 :
154 0 : switch (argc - optind)
155 : {
156 : case 0:
157 : break;
158 : case 1:
159 0 : dbname = argv[optind];
160 0 : break;
161 : case 2:
162 0 : dbname = argv[optind];
163 0 : comment = argv[optind + 1];
164 0 : break;
165 : default:
166 0 : pg_log_error("too many command-line arguments (first is \"%s\")",
167 : argv[optind + 2]);
168 0 : pg_log_error_hint("Try \"%s --help\" for more information.", progname);
169 0 : exit(1);
170 : }
171 :
172 0 : if (encoding)
173 : {
174 0 : if (pg_char_to_encoding(encoding) < 0)
175 0 : pg_fatal("\"%s\" is not a valid encoding name", encoding);
176 0 : }
177 :
178 0 : if (dbname == NULL)
179 : {
180 0 : if (getenv("PGDATABASE"))
181 0 : dbname = getenv("PGDATABASE");
182 0 : else if (getenv("PGUSER"))
183 0 : dbname = getenv("PGUSER");
184 : else
185 0 : dbname = get_user_name_or_exit(progname);
186 0 : }
187 :
188 : /* No point in trying to use postgres db when creating postgres db. */
189 0 : if (maintenance_db == NULL && strcmp(dbname, "postgres") == 0)
190 0 : maintenance_db = "template1";
191 :
192 0 : cparams.dbname = maintenance_db;
193 0 : cparams.pghost = host;
194 0 : cparams.pgport = port;
195 0 : cparams.pguser = username;
196 0 : cparams.prompt_password = prompt_password;
197 0 : cparams.override_dbname = NULL;
198 :
199 0 : conn = connectMaintenanceDatabase(&cparams, progname, echo);
200 :
201 0 : setFmtEncoding(PQclientEncoding(conn));
202 :
203 0 : initPQExpBuffer(&sql);
204 :
205 0 : appendPQExpBuffer(&sql, "CREATE DATABASE %s",
206 0 : fmtId(dbname));
207 :
208 0 : if (owner)
209 0 : appendPQExpBuffer(&sql, " OWNER %s", fmtId(owner));
210 0 : if (tablespace)
211 0 : appendPQExpBuffer(&sql, " TABLESPACE %s", fmtId(tablespace));
212 0 : if (encoding)
213 : {
214 0 : appendPQExpBufferStr(&sql, " ENCODING ");
215 0 : appendStringLiteralConn(&sql, encoding, conn);
216 0 : }
217 0 : if (strategy)
218 0 : appendPQExpBuffer(&sql, " STRATEGY %s", fmtId(strategy));
219 0 : if (template)
220 0 : appendPQExpBuffer(&sql, " TEMPLATE %s", fmtId(template));
221 0 : if (locale)
222 : {
223 0 : appendPQExpBufferStr(&sql, " LOCALE ");
224 0 : appendStringLiteralConn(&sql, locale, conn);
225 0 : }
226 0 : if (builtin_locale)
227 : {
228 0 : appendPQExpBufferStr(&sql, " BUILTIN_LOCALE ");
229 0 : appendStringLiteralConn(&sql, builtin_locale, conn);
230 0 : }
231 0 : if (lc_collate)
232 : {
233 0 : appendPQExpBufferStr(&sql, " LC_COLLATE ");
234 0 : appendStringLiteralConn(&sql, lc_collate, conn);
235 0 : }
236 0 : if (lc_ctype)
237 : {
238 0 : appendPQExpBufferStr(&sql, " LC_CTYPE ");
239 0 : appendStringLiteralConn(&sql, lc_ctype, conn);
240 0 : }
241 0 : if (locale_provider)
242 0 : appendPQExpBuffer(&sql, " LOCALE_PROVIDER %s", fmtId(locale_provider));
243 0 : if (icu_locale)
244 : {
245 0 : appendPQExpBufferStr(&sql, " ICU_LOCALE ");
246 0 : appendStringLiteralConn(&sql, icu_locale, conn);
247 0 : }
248 0 : if (icu_rules)
249 : {
250 0 : appendPQExpBufferStr(&sql, " ICU_RULES ");
251 0 : appendStringLiteralConn(&sql, icu_rules, conn);
252 0 : }
253 :
254 0 : appendPQExpBufferChar(&sql, ';');
255 :
256 0 : if (echo)
257 0 : printf("%s\n", sql.data);
258 0 : result = PQexec(conn, sql.data);
259 :
260 0 : if (PQresultStatus(result) != PGRES_COMMAND_OK)
261 : {
262 0 : pg_log_error("database creation failed: %s", PQerrorMessage(conn));
263 0 : PQfinish(conn);
264 0 : exit(1);
265 : }
266 :
267 0 : PQclear(result);
268 :
269 0 : if (comment)
270 : {
271 0 : printfPQExpBuffer(&sql, "COMMENT ON DATABASE %s IS ", fmtId(dbname));
272 0 : appendStringLiteralConn(&sql, comment, conn);
273 0 : appendPQExpBufferChar(&sql, ';');
274 :
275 0 : if (echo)
276 0 : printf("%s\n", sql.data);
277 0 : result = PQexec(conn, sql.data);
278 :
279 0 : if (PQresultStatus(result) != PGRES_COMMAND_OK)
280 : {
281 0 : pg_log_error("comment creation failed (database was created): %s",
282 : PQerrorMessage(conn));
283 0 : PQfinish(conn);
284 0 : exit(1);
285 : }
286 :
287 0 : PQclear(result);
288 0 : }
289 :
290 0 : PQfinish(conn);
291 :
292 0 : exit(0);
293 : }
294 :
295 :
296 : static void
297 0 : help(const char *progname)
298 : {
299 0 : printf(_("%s creates a PostgreSQL database.\n\n"), progname);
300 0 : printf(_("Usage:\n"));
301 0 : printf(_(" %s [OPTION]... [DBNAME] [DESCRIPTION]\n"), progname);
302 0 : printf(_("\nOptions:\n"));
303 0 : printf(_(" -D, --tablespace=TABLESPACE default tablespace for the database\n"));
304 0 : printf(_(" -e, --echo show the commands being sent to the server\n"));
305 0 : printf(_(" -E, --encoding=ENCODING encoding for the database\n"));
306 0 : printf(_(" -l, --locale=LOCALE locale settings for the database\n"));
307 0 : printf(_(" --lc-collate=LOCALE LC_COLLATE setting for the database\n"));
308 0 : printf(_(" --lc-ctype=LOCALE LC_CTYPE setting for the database\n"));
309 0 : printf(_(" --builtin-locale=LOCALE builtin locale setting for the database\n"));
310 0 : printf(_(" --icu-locale=LOCALE ICU locale setting for the database\n"));
311 0 : printf(_(" --icu-rules=RULES ICU rules setting for the database\n"));
312 0 : printf(_(" --locale-provider={builtin|libc|icu}\n"
313 : " locale provider for the database's default collation\n"));
314 0 : printf(_(" -O, --owner=OWNER database user to own the new database\n"));
315 0 : printf(_(" -S, --strategy=STRATEGY database creation strategy wal_log or file_copy\n"));
316 0 : printf(_(" -T, --template=TEMPLATE template database to copy\n"));
317 0 : printf(_(" -V, --version output version information, then exit\n"));
318 0 : printf(_(" -?, --help show this help, then exit\n"));
319 0 : printf(_("\nConnection options:\n"));
320 0 : printf(_(" -h, --host=HOSTNAME database server host or socket directory\n"));
321 0 : printf(_(" -p, --port=PORT database server port\n"));
322 0 : printf(_(" -U, --username=USERNAME user name to connect as\n"));
323 0 : printf(_(" -w, --no-password never prompt for password\n"));
324 0 : printf(_(" -W, --password force password prompt\n"));
325 0 : printf(_(" --maintenance-db=DBNAME alternate maintenance database\n"));
326 0 : printf(_("\nBy default, a database with the same name as the current user is created.\n"));
327 0 : printf(_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
328 0 : printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL);
329 0 : }
|
