PostgreSQL 中文参考文档
🌐 英文原版 官方 ↗

createdb

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

Synopsis

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 服务器支持的字符集在 Section 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 提供者时的区域设置名称。区域设置支持在 Section 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。它可以是一个 连接字符串。如果是这样,连接字符串参数将覆盖与之冲突的命令行选项。

环境

PGDATABASE

如果设置了该变量,则它指定要创建的数据库名,除非在命令行上被覆盖。

PGHOST
PGPORT
PGUSER

默认连接参数。如果没有在命令行上或通过 PGDATABASE 指定要创建的数据库名,PGUSER 还将决定要创建的数据库名。

PG_COLOR

指定是否在诊断消息中使用颜色。可能的值是 always、auto 和 never。

与大多数其他 PostgreSQL 工具一样,此工具也使用 libpq 支持的环境变量(参见 Section 32.15)。

诊断

如果遇到问题,请参见 CREATE DATABASE 和 psql 中对潜在问题和错误消息的讨论。数据库服务器必须在目标主机上运行。此外,libpq 前端库使用的任何默认连接设置和环境变量也将生效。

示例

使用默认数据库服务器创建数据库 demo:

$ createdb demo

使用主机 eden 上端口 5000 的服务器并采用 template0 模板数据库来创建数据库 demo,下面是命令行命令以及底层的 SQL 命令:

$ createdb -p 5000 -h eden -T template0 -e demo
CREATE DATABASE demo TEMPLATE template0;

另请参阅

dropdb, CREATE DATABASE