2024年9月26日:PostgreSQL 17 发布!
支持的版本:当前 (17) / 16 / 15 / 14 / 13 / 12
开发版本:devel
不受支持的版本:11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4 / 7.3 / 7.2 / 7.1

pg_ctl

pg_ctl — 初始化、启动、停止或控制 PostgreSQL 服务器

概要

pg_ctl init[db] [-D datadir] [-s] [-o initdb-options]

pg_ctl start [-D datadir] [-l filename] [-W] [-t seconds] [-s] [-o options] [-p path] [-c]

pg_ctl stop [-D datadir] [-m s[mart] | f[ast] | i[mmediate] ] [-W] [-t seconds] [-s]

pg_ctl restart [-D datadir] [-m s[mart] | f[ast] | i[mmediate] ] [-W] [-t seconds] [-s] [-o options] [-c]

pg_ctl reload [-D datadir] [-s]

pg_ctl status [-D datadir]

pg_ctl promote [-D datadir] [-W] [-t seconds] [-s]

pg_ctl logrotate [-D datadir] [-s]

pg_ctl kill signal_name process_id

在 Microsoft Windows 上,还可以使用

pg_ctl register [-D datadir] [-N servicename] [-U username] [-P password] [-S a[uto] | d[emand] ] [-e source] [-W] [-t seconds] [-s] [-o options]

pg_ctl unregister [-N servicename]

描述

pg_ctl 是一个用于初始化 PostgreSQL 数据库集群、启动、停止或重启 PostgreSQL 数据库服务器 (postgres) 或显示正在运行的服务器状态的实用程序。虽然服务器可以手动启动,但 pg_ctl 封装了诸如重定向日志输出和正确地与终端和进程组分离等任务。它还提供了用于受控关闭的便捷选项。

initinitdb 模式创建一个新的 PostgreSQL 数据库集群,即由单个服务器实例管理的一组数据库。此模式调用 initdb 命令。有关详细信息,请参阅 initdb

start 模式启动一个新的服务器。服务器在后台启动,其标准输入连接到 /dev/null(或 Windows 上的 nul)。在类 Unix 系统上,默认情况下,服务器的标准输出和标准错误发送到 pg_ctl 的标准输出(而不是标准错误)。然后,应将 pg_ctl 的标准输出重定向到文件或通过管道传输到另一个进程(例如像 rotatelogs 这样的日志轮转程序);否则,postgres 会将其输出写入控制终端(从后台),并且不会离开 shell 的进程组。在 Windows 上,默认情况下,服务器的标准输出和标准错误发送到终端。可以通过使用 -l 将服务器的输出追加到日志文件来更改这些默认行为。建议使用 -l 或输出重定向。

stop 模式关闭在指定数据目录中运行的服务器。可以使用 -m 选项选择三种不同的关闭方法。智能 模式不允许新的连接,然后等待所有现有客户端断开连接。如果服务器处于热备状态,则一旦所有客户端断开连接,恢复和流式复制将被终止。快速 模式(默认模式)不会等待客户端断开连接。所有活动事务都将回滚,客户端将被强制断开连接,然后服务器将关闭。立即 模式将立即中止所有服务器进程,而不会进行干净关闭。此选择将在下一次服务器启动期间导致崩溃恢复周期。

restart 模式有效地执行停止然后启动的操作。这允许更改 postgres 命令行选项,或更改无法在不重启服务器的情况下更改的配置文件选项。如果在服务器启动期间在命令行中使用了相对路径,则 restart 可能会失败,除非 pg_ctl 在与服务器启动期间相同的当前目录中执行。

reload 模式只是向 postgres 服务器进程发送 SIGHUP 信号,使其重新读取其配置文件(postgresql.confpg_hba.conf 等)。这允许更改不需要完全服务器重启即可生效的配置文件选项。

status 模式检查服务器是否在指定的数据目录中运行。如果是,则服务器的PID以及用于调用它的命令行选项将显示。如果服务器未运行,pg_ctl 将返回退出状态 3。如果没有指定可访问的数据目录,pg_ctl 将返回退出状态 4。

promote 模式命令在指定数据目录中运行的备用服务器结束备用模式并开始读写操作。

logrotate 模式轮换服务器日志文件。有关如何与外部日志轮换工具一起使用此模式的详细信息,请参阅 第 24.3 节

kill 模式向指定的进程发送信号。这主要在 Microsoft Windows 上很有用,后者没有内置的 kill 命令。使用 --help 查看支持的信号名称列表。

register 模式在 Microsoft Windows 上将 PostgreSQL 服务器注册为系统服务。-S 选项允许选择服务启动类型,即 自动(在系统启动时自动启动服务)或 按需(按需启动服务)。

unregister 模式取消注册 Microsoft Windows 上的系统服务。这将撤消 register 命令的效果。

选项

-c
--core-files

尝试允许服务器崩溃生成核心文件(在可能的情况下),方法是取消对核心文件施加的任何软资源限制。这在调试或诊断问题时很有用,因为它允许从失败的服务器进程中获取堆栈跟踪。

-D datadir
--pgdata=datadir

指定数据库配置文件的文件系统位置。如果省略此选项,则使用环境变量 PGDATA

-l filename
--log=filename

将服务器日志输出追加到 filename。如果文件不存在,则创建它。umask 设置为 077,因此默认情况下其他用户无法访问日志文件。

-m mode
--mode=mode

指定关闭模式。mode 可以是 smartfastimmediate,或者这三个中的任意一个的首字母。如果省略此选项,则默认为 fast

-o options
--options=options

指定要直接传递给 postgres 命令的选项。-o 可以多次指定,所有给定的选项都将被传递。

通常应将 options 括在单引号或双引号中,以确保它们作为一组传递。

-o initdb-options
--options=initdb-options

指定要直接传递给 initdb 命令的选项。-o 可以多次指定,所有给定的选项都将被传递。

通常应将 initdb-options 括在单引号或双引号中,以确保它们作为一组传递。

-p path

指定 postgres 可执行文件的位置。默认情况下,postgres 可执行文件取自与 pg_ctl 相同的目录,或者如果失败,则取自硬编码的安装目录。除非您正在执行一些不寻常的操作并收到 postgres 可执行文件未找到的错误,否则无需使用此选项。

init 模式下,此选项类似地指定 initdb 可执行文件的位置。

-s
--silent

仅打印错误,不打印信息消息。

-t seconds
--timeout=seconds

指定等待操作完成时的最大秒数(参见选项 -w)。默认为 PGCTLTIMEOUT 环境变量的值,如果未设置,则默认为 60 秒。

-V
--version

打印 pg_ctl 版本并退出。

-w
--wait

等待操作完成。这在 startstoprestartpromoteregister 模式下受支持,并且是这些模式的默认值。

等待时,pg_ctl 会重复检查服务器的PID文件,在每次检查之间休眠一小段时间。当PID文件指示服务器已准备好接受连接时,启动即被视为完成。当服务器删除PID文件时,关闭即被视为完成。pg_ctl 根据启动或关闭的成功情况返回退出代码。

如果操作在超时时间内(参见选项 -t)未完成,则 pg_ctl 会以非零退出状态退出。但请注意,操作可能会在后台继续并最终成功。

-W
--no-wait

不要等待操作完成。这与选项 -w 相反。

如果禁用等待,则会触发请求的操作,但不会反馈其成功情况。在这种情况下,必须使用服务器日志文件或外部监控系统来检查操作的进度和成功情况。

在先前版本的 PostgreSQL 中,这是默认设置,除了 stop 模式。

-?
--help

显示有关 pg_ctl 命令行参数的帮助,并退出。

如果指定的选项有效,但不适用于所选的操作模式,则 pg_ctl 会忽略它。

Windows 选项

-e source

作为 Windows 服务运行时,pg_ctl 用于将日志记录到事件日志的事件源的名称。默认为 PostgreSQL。请注意,这仅控制从 pg_ctl 本身发送的消息;一旦启动,服务器将使用其 event_source 参数指定的事件源。如果服务器在启动初期(在设置该参数之前)失败,它也可能使用默认事件源名称 PostgreSQL 记录日志。

-N servicename

要注册的系统服务的名称。此名称将用作服务名称和显示名称。默认为 PostgreSQL

-P password

以其运行服务的用户的密码。

-S start-type

系统服务的启动类型。start-type 可以是 autodemand,或者这两个中的任意一个的首字母。如果省略此选项,则默认为 auto

-U username

以其运行服务的用户的用户名。对于域用户,请使用格式 DOMAIN\username

环境

PGCTLTIMEOUT

等待启动或关闭完成时的默认秒数限制。如果未设置,则默认为 60 秒。

PGDATA

默认数据目录位置。

大多数 pg_ctl 模式需要知道数据目录位置;因此,除非设置了 PGDATA,否则需要使用 -D 选项。

有关影响服务器的其他变量,请参见 postgres

文件

postmaster.pid

pg_ctl 检查数据目录中的此文件以确定服务器当前是否正在运行。

postmaster.opts

如果此文件存在于数据目录中,则 pg_ctl(在 restart 模式下)会将文件的内容作为选项传递给 postgres,除非被 -o 选项覆盖。此文件的内容也会在 status 模式下显示。

示例

启动服务器

要启动服务器,并等待服务器接受连接,请使用

$ pg_ctl start

要使用端口 5433 启动服务器,并在没有 fsync 的情况下运行,请使用

$ pg_ctl -o "-F -p 5433" start

停止服务器

要停止服务器,请使用

$ pg_ctl stop

-m 选项允许控制服务器 如何关闭

$ pg_ctl stop -m smart

重启服务器

重启服务器几乎等同于停止服务器并再次启动它,但默认情况下,pg_ctl 会保存并重用传递给先前运行的实例的命令行选项。要使用与之前相同的选项重启服务器,请使用

$ pg_ctl restart

但是,如果指定了 -o,则它会替换任何以前的选项。要使用端口 5433 重启,并在重启时禁用 fsync,请使用

$ pg_ctl -o "-F -p 5433" restart

显示服务器状态

以下是 pg_ctl 的示例状态输出

$ pg_ctl status

pg_ctl: server is running (PID: 13718)
/usr/local/pgsql/bin/postgres "-D" "/usr/local/pgsql/data" "-p" "5433" "-B" "128"

第二行是将在重启模式下调用的命令。

另请参阅

initdbpostgres

提交更正

如果您在文档中看到任何不正确的内容、与您对特定功能的体验不符的内容或需要进一步说明的内容,请使用 此表单 报告文档问题。