百科 / 命令行工具 / 客户端程序

createdb

当前查看 PostgreSQL 18。

中文定义与说明

命令行工具 createdb [ connection-option ...] [ option ...] [ dbname [ description ]]。

同版本中文手册节选

描述

createdb 创建一个新的 PostgreSQL 数据库。

通常，执行此命令的数据库用户会成为新数据库的所有者。不过，如果执行用户具有相应的权限，也可以通过 -O 选项指定不同的所有者。

createdb 是 SQL 命令 CREATE DATABASE 的一个包装器。通过该工具创建数据库，与通过其他访问服务器的方法创建数据库在实际效果上没有区别。

选项

createdb 接受下列命令行参数：

dbname: 指定要创建的数据库名称。该名称必须在此数据库集簇中的所有 PostgreSQL 数据库中唯一。默认情况下，会创建一个与当前系统用户同名的数据库。
description: 指定要与新创建的数据库关联的注释。
-D tablespace --tablespace=tablespace: 指定数据库的默认表空间。（该名称将按双引号标识符处理。）
-e --echo: 回显 createdb 生成并发送到服务器的命令。
-E encoding --encoding=encoding: 指定该数据库使用的字符集编码。PostgreSQL 服务器支持的字符集见第 23.3.1 节。
-l locale --locale=locale: 指定该数据库要使用的区域设置。这等同于为 --lc-collate、--lc-ctype 和 --icu-locale 指定相同的值。某些区域设置仅对 ICU 有效，必须通过 --icu-locale 设置。
--lc-collate=locale: 指定该数据库要使用的 LC_COLLATE 设置。
--lc-ctype=locale: 指定该数据库要使用的 LC_CTYPE 设置。
--builtin-locale=locale: 当使用 builtin 提供程序时，指定区域设置名称。区域设置支持的说明见第 23.1 节。
--icu-locale=locale: 如果选择了 ICU 区域设置提供程序，则指定该数据库要使用的 ICU 区域设置 ID。
--icu-rules=rules: 指定附加的排序规则，用以定制该数据库默认排序规则的行为。该选项仅支持 ICU。
--locale-provider={builtin|libc|icu}: 指定数据库默认排序规则所使用的区域设置提供程序。
-O owner --owner=owner: 指定将成为新数据库拥有者的数据库用户。（该名称按双引号标识符处理。）
-S strategy --strategy=strategy: 指定数据库创建策略。详见 CREATE DATABASE STRATEGY。
-T template --template=template: 指定用于构建该数据库的模板数据库。（该名称按双引号标识符处理。）
-V --version: 打印 createdb 的版本并退出。
-? --help: 显示有关 createdb 命令行参数的帮助信息，并退出。

选项 -D、-l、-E、-O 和 -T 对应于底层 SQL 命令 CREATE DATABASE 的选项；有关这些选项的更多信息请参阅该命令。

createdb 也接受下列与连接参数有关的命令行参数：

-h host --host=host

指定服务器所在机器的主机名。如果该值以斜杠开头，则它将被用作 Unix 域套接字的目录。

-p port --port=port

指定服务器监听连接所用的 TCP 端口或本地 Unix 域套接字文件扩展名。

-U username --username=username

以该用户名进行连接。

-w --no-password

从不发出密码提示。如果服务器要求密码认证，而密码又无法通过诸如.pgpass 文件等其他方式获得，则连接尝试将失败。该选项适合没有用户在场输入密码的批处理作业和脚本。

-W --password

强制 createdb 在连接到数据库之前提示输入密码。

这个选项并非必不可少，因为如果服务器要求密码认证，createdb 会自动提示输入密码。不过，createdb 会浪费一次连接尝试，才知道服务器需要密码。在某些情况下，为了避免这次额外的连接尝试，提前指定 -W 是值得的。

--maintenance-db=dbname

指定在创建新数据库时要连接到的数据库名称。如果未指定，将使用 postgres 数据库；若该数据库不存在（或者它正是要创建的新数据库），则改用 template1。这也可以是一个连接字符串。如果是这种情况，其中的连接字符串参数将覆盖任何冲突的命令行选项。

查看完整中文手册与上下文。

说明

描述 createdb 创建一个新的 PostgreSQL 数据库。通常，执行此命令的数据库用户会成为新数据库的所有者。不过，如果执行用户具有相应的权限，也可以通过 -O 选项指定不同的所有者。 createdb 是 SQL 命令 CREATE DATABASE 的一个包装器。通过该工具创建数据库，与通过其他访问服务器的方法创建数据库在实际效果上没有区别。选项 createdb 接受下列命令行参数： dbname 指定要创建的数据库名称。该名称必须在此数据库集簇中的所有 PostgreSQL 数据库中唯一。默认情况下，会创建一个与当前系统用户同名的数据库。 description 指定要与新创建的数据库关联的注释。 -D tablespace --tablespace= tablespace 指定数据库的默认表空间。（该名称将按双引号标识符处理。） -e --echo 回显 createdb 生成并发送到服务器的命令。 -E encoding --encoding= encoding 指定该数据库使用的字符集编码。 PostgreSQL 服务器支持的字符集见第 23.3.1 节。 -l locale --locale= locale 指定该数据库要使用的区域设置。这等同于为 --lc-collate 、 --lc-ctype 和 --icu-locale 指定相同的值。某些区域设置仅对 ICU 有效，必须通过 --icu-locale 设置。 --lc-collate= locale 指定该数据库要使用的 LC_COLLATE 设置。 --lc-ctype= locale 指定该数据库要使用的 LC_CTYPE 设置。 --builtin-locale= locale 当使用 builtin 提供程序时，指定区域设置名称。区域设置支持的说明见第 23.1 节。 --icu-locale= locale 如果选择了 ICU 区域设置提供程序，则指定该数据库要使用的 ICU 区域设置 ID。 --icu-rules= rules 指定附加的排序规则，用以定制该数

手册中的可执行程序: createdb
程序版本: 18.6
参考清单: 客户端程序
选项定义组: 21

用法

createdb [ connection-option ...] [ option ...] [ dbname [ description ]]

手册中的选项

选项与参数	说明
-D tablespace --tablespace= tablespace	指定数据库的默认表空间。（该名称将按双引号标识符处理。）
-e --echo	回显 createdb 生成并发送到服务器的命令。
-E encoding --encoding= encoding	指定该数据库使用的字符集编码。 PostgreSQL 服务器支持的字符集见第 23.3.1 节。
-l locale --locale= locale	指定该数据库要使用的区域设置。这等同于为 --lc-collate 、 --lc-ctype 和 --icu-locale 指定相同的值。某些区域设置仅对 ICU 有效，必须通过 --icu-locale 设置。
--lc-collate= locale	指定该数据库要使用的 LC_COLLATE 设置。
--lc-ctype= locale	指定该数据库要使用的 LC_CTYPE 设置。
--builtin-locale= locale	当使用 builtin 提供程序时，指定区域设置名称。区域设置支持的说明见第 23.1 节。
--icu-locale= locale	如果选择了 ICU 区域设置提供程序，则指定该数据库要使用的 ICU 区域设置 ID。
--icu-rules= rules	指定附加的排序规则，用以定制该数据库默认排序规则的行为。该选项仅支持 ICU。
--locale-provider={ builtin \| libc \| icu }	指定数据库默认排序规则所使用的区域设置提供程序。
-O owner --owner= owner	指定将成为新数据库拥有者的数据库用户。（该名称按双引号标识符处理。）
-S strategy --strategy= strategy	指定数据库创建策略。详见 CREATE DATABASE STRATEGY 。
-T template --template= template	指定用于构建该数据库的模板数据库。（该名称按双引号标识符处理。）
-V --version	打印 createdb 的版本并退出。
-? --help	显示有关 createdb 命令行参数的帮助信息，并退出。
-h host --host= host	指定服务器所在机器的主机名。如果该值以斜杠开头，则它将被用作 Unix 域套接字的目录。
-p port --port= port	指定服务器监听连接所用的 TCP 端口或本地 Unix 域套接字文件扩展名。
-U username --username= username	以该用户名进行连接。
-w --no-password	从不发出密码提示。如果服务器要求密码认证，而密码又无法通过诸如 .pgpass 文件等其他方式获得，则连接尝试将失败。该选项适合没有用户在场输入密码的批处理作业和脚本。
-W --password	强制 createdb 在连接到数据库之前提示输入密码。
--maintenance-db= dbname	指定在创建新数据库时要连接到的数据库名称。如果未指定，将使用 postgres 数据库；若该数据库不存在（或者它正是要创建的新数据库），则改用 template1 。这也可以是一个连接字符串。如果是这种情况，其中的连接字符串参数将覆盖任何冲突的命令行选项。

环境变量

变量	含义
PGDATABASE	如果设置了该变量，其值就是要创建的数据库名称，除非被命令行覆盖。
PGHOST PGPORT PGUSER	默认连接参数。如果没有通过命令行或 PGDATABASE 指定待创建数据库的名称，PGUSER 也会决定该名称。
PG_COLOR	指定诊断消息是否使用颜色。可选值为 always 、 auto 和 never 。

文档与源码

来源构建

版本: 18.6
构建: https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2
来源指纹: ee8d1a3612338fd9adf250730cb640fcc5233b5491337cc00a316a44e3a0b9f8

版本比较

PostgreSQL 17 → 18: 无变化。

比较已记录的接口与属性，排除来源指纹和构建元数据。某个样本中没有记录，不能据此判断实际引入或移除的版本。

快速链接