Postgresql 中文操作指南
pg_ctl
pg_ctl — 初始化、启动、停止或控制 PostgreSQL 服务器
pg_ctl — initialize, start, stop, or control a PostgreSQL server
Synopsis
pg_ctl init[db] [ -D datadir ] [ -s ] [ -o initdb-options ]
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 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 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 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 reload [-D datadir] [-s]
pg_ctl status [ -D datadir ]
pg_ctl status [-D datadir]
pg_ctl promote [ -D datadir ] [ -W ] [ -t seconds ] [ -s ]
pg_ctl promote [-D datadir] [-W] [-t seconds] [-s]
pg_ctl logrotate [ -D datadir ] [ -s ]
pg_ctl logrotate [-D datadir] [-s]
pg_ctl kill signal_name process_id
pg_ctl kill signal_name process_id
在 Microsoft Windows 上,还有:
On Microsoft Windows, also:
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 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 unregister [-N servicename]
Description
pg_ctl 是用于初始化 PostgreSQL 数据库群集、启动、停止或重新启动 PostgreSQL 数据库服务器 ( postgres ),或显示正在运行服务器状态的实用工具。虽然可以手动启动服务器,但 pg_ctl 封装了诸如重定向日志输出以及从终端和进程组正确分离的任务。它还为受控关机提供了便利选项。
pg_ctl is a utility for initializing a PostgreSQL database cluster, starting, stopping, or restarting the PostgreSQL database server (postgres), or displaying the status of a running server. Although the server can be started manually, pg_ctl encapsulates tasks such as redirecting log output and properly detaching from the terminal and process group. It also provides convenient options for controlled shutdown.
init 或 initdb 模式创建新的 PostgreSQL 数据库群集,即单个服务器实例将管理的数据库集合。此模式调用 initdb 命令。有关详细信息,请参见 initdb 。
The init or initdb mode creates a new PostgreSQL database cluster, that is, a collection of databases that will be managed by a single server instance. This mode invokes the initdb command. See initdb for details.
start 模式启动新服务器。服务器在后台启动,其标准输入附加到 /dev/null (或在 Windows 上附加到 nul )。在类 Unix 系统上的常规情况下,服务器的标准输出和标准错误发送到 pg_ctl 的标准输出(不是标准错误)。然后应将 pg_ctl 的标准输出重定向到文件,或通过管道传输到其他进程(如 rotatelogs 等日志循环程序);否则 postgres 会在其输出中写入对控制终端(从后台进行)并且不会离开 shell 的进程组。在 Windows 上,服务器的标准输出和标准错误按默认设置发送到终端。可以通过使用 -l 将服务器输出附加到日志文件,来更改这些默认行为。建议使用 -l 或输出重定向。
start mode launches a new server. The server is started in the background, and its standard input is attached to /dev/null (or nul on Windows). On Unix-like systems, by default, the server’s standard output and standard error are sent to pg_ctl’s standard output (not standard error). The standard output of pg_ctl should then be redirected to a file or piped to another process such as a log rotating program like rotatelogs; otherwise postgres will write its output to the controlling terminal (from the background) and will not leave the shell’s process group. On Windows, by default the server’s standard output and standard error are sent to the terminal. These default behaviors can be changed by using -l to append the server’s output to a log file. Use of either -l or output redirection is recommended.
stop 模式关闭在指定数据目录中运行的服务器。可以使用 -m 选项,选择三种不同的关闭方法。“智能”模式禁止新连接,然后等待所有现有客户端断开连接。如果服务器处于热备用状态,一旦所有客户端断开连接,将终止恢复和流式复制。“快速”模式(默认设置)不等待客户端断开连接。所有活动事务将回滚,客户端将被强制断开连接,然后关闭服务器。“立即”模式将立即中止所有服务器进程,而不会进行清理关闭。在下次服务器启动期间,此选择会产生一个故障恢复周期。
stop mode shuts down the server that is running in the specified data directory. Three different shutdown methods can be selected with the -m option. “Smart” mode disallows new connections, then waits for all existing clients to disconnect. If the server is in hot standby, recovery and streaming replication will be terminated once all clients have disconnected. “Fast” mode (the default) does not wait for clients to disconnect. All active transactions are rolled back and clients are forcibly disconnected, then the server is shut down. “Immediate” mode will abort all server processes immediately, without a clean shutdown. This choice will lead to a crash-recovery cycle during the next server start.
restart 模式有效地执行一个停止,然后执行一个启动。这允许更改 postgres 命令行选项,或更改在不重新启动服务器的情况下无法更改的配置文件选项。如果在服务器启动期间在命令行上使用了相对路径,除非以在服务器启动期间相同的当前目录中执行 pg_ctl,否则 restart 可能会失败。
restart mode effectively executes a stop followed by a start. This allows changing the postgres command-line options, or changing configuration-file options that cannot be changed without restarting the server. If relative paths were used on the command line during server start, restart might fail unless pg_ctl is executed in the same current directory as it was during server start.
reload 模式只是向 postgres 服务器进程发送 SIGHUP 信号,使其重新读取其配置文件( postgresql.conf 、 pg_hba.conf 等)。这允许更改不需要完全重启服务器才能生效的配置文件选项。
reload mode simply sends the postgres server process a SIGHUP signal, causing it to reread its configuration files (postgresql.conf, pg_hba.conf, etc.). This allows changing configuration-file options that do not require a full server restart to take effect.
status 模式检查指定的 data 目录中是否运行着服务器。如果是,则显示服务器的 PID 和用于对其进行调用的命令行选项。如果服务器未运行,pg_ctl 会返回以 3 为退出状态。如果没有指定可访问的 data 目录,pg_ctl 会返回以 4 为退出状态。
status mode checks whether a server is running in the specified data directory. If it is, the server’s PID and the command line options that were used to invoke it are displayed. If the server is not running, pg_ctl returns an exit status of 3. If an accessible data directory is not specified, pg_ctl returns an exit status of 4.
promote 模式命令运行在指定 data 目录中的备用服务器结束备用模式并开始读写操作。
promote mode commands the standby server that is running in the specified data directory to end standby mode and begin read-write operations.
logrotate 模式轮换服务器日志文件。有关如何将此模式与外部日志轮换工具一起使用的详细信息,请参阅 Section 25.3 。
logrotate mode rotates the server log file. For details on how to use this mode with external log rotation tools, see Section 25.3.
kill 模式向指定进程发送一个信号。这主要在没有内置 kill 命令的 Microsoft Windows 上很有价值。使用 —help 查看支持的信号名称列表。
kill mode sends a signal to a specified process. This is primarily valuable on Microsoft Windows which does not have a built-in kill command. Use —help to see a list of supported signal names.
register 模式在 Microsoft Windows 上将 PostgreSQL 服务器注册为系统服务。 -S 选项允许选择服务的启动类型,包括"自动"(系统启动时自动启动服务)或"按需"(按需启动服务)。
register mode registers the PostgreSQL server as a system service on Microsoft Windows. The -S option allows selection of service start type, either “auto” (start service automatically on system startup) or “demand” (start service on demand).
unregister 模式取消在 Microsoft Windows 上注册的系统服务。这会撤消 register 命令的影响。
unregister mode unregisters a system service on Microsoft Windows. This undoes the effects of the register command.
Options
-
-c_—core-files_
-
Attempt to allow server crashes to produce core files, on platforms where this is possible, by lifting any soft resource limit placed on core files. This is useful in debugging or diagnosing problems by allowing a stack trace to be obtained from a failed server process.
-
-
-D _datadir—pgdata=_datadir
-
Specifies the file system location of the database configuration files. If this option is omitted, the environment variable PGDATA is used.
-
-
-l _filename—log=_filename
-
Append the server log output to filename. If the file does not exist, it is created. The umask is set to 077, so access to the log file is disallowed to other users by default.
-
-
-m _mode—mode=_mode
-
Specifies the shutdown mode. mode can be smart, fast, or immediate, or the first letter of one of these three. If this option is omitted, fast is the default.
-
-
-o _options—options=_options
-
Specifies options to be passed directly to the postgres command. -o can be specified multiple times, with all the given options being passed through.
-
The options should usually be surrounded by single or double quotes to ensure that they are passed through as a group.
-
-
-o _initdb-options—options=_initdb-options
-
Specifies options to be passed directly to the initdb command. -o can be specified multiple times, with all the given options being passed through.
-
The initdb-options should usually be surrounded by single or double quotes to ensure that they are passed through as a group.
-
-
-p _path_
-
Specifies the location of the postgres executable. By default the postgres executable is taken from the same directory as pg_ctl, or failing that, the hard-wired installation directory. It is not necessary to use this option unless you are doing something unusual and get errors that the postgres executable was not found.
-
In init mode, this option analogously specifies the location of the initdb executable.
-
-
-s_—silent_
-
Print only errors, no informational messages.
-
-
-t _seconds—timeout=_seconds
-
Specifies the maximum number of seconds to wait when waiting for an operation to complete (see option -w). Defaults to the value of the PGCTLTIMEOUT environment variable or, if not set, to 60 seconds.
-
-
-V_—version_
-
Print the pg_ctl version and exit.
-
-
-w_—wait_
-
Wait for the operation to complete. This is supported for the modes start, stop, restart, promote, and register, and is the default for those modes.
-
When waiting, pg_ctl repeatedly checks the server’s PID file, sleeping for a short amount of time between checks. Startup is considered complete when the PID file indicates that the server is ready to accept connections. Shutdown is considered complete when the server removes the PID file. pg_ctl returns an exit code based on the success of the startup or shutdown.
-
If the operation does not complete within the timeout (see option -t), then pg_ctl exits with a nonzero exit status. But note that the operation might continue in the background and eventually succeed.
-
-
-W_—no-wait_
-
Do not wait for the operation to complete. This is the opposite of the option -w.
-
If waiting is disabled, the requested action is triggered, but there is no feedback about its success. In that case, the server log file or an external monitoring system would have to be used to check the progress and success of the operation.
-
In prior releases of PostgreSQL, this was the default except for the stop mode.
-
-
-?_—help_
-
Show help about pg_ctl command line arguments, and exit.
-
如果指定了有效但不适用于所选操作模式的选项,pg_ctl 将忽略该选项。
If an option is specified that is valid, but not relevant to the selected operating mode, pg_ctl ignores it.
Options for Windows
-
-e _source_
-
Name of the event source for pg_ctl to use for logging to the event log when running as a Windows service. The default is PostgreSQL. Note that this only controls messages sent from pg_ctl itself; once started, the server will use the event source specified by its event_source parameter. Should the server fail very early in startup, before that parameter has been set, it might also log using the default event source name PostgreSQL.
-
-
-N _servicename_
-
Name of the system service to register. This name will be used as both the service name and the display name. The default is PostgreSQL.
-
-
-P _password_
-
Password for the user to run the service as.
-
-
-S _start-type_
-
Start type of the system service. start-type can be auto, or demand, or the first letter of one of these two. If this option is omitted, auto is the default.
-
-
-U _username_
-
User name for the user to run the service as. For domain users, use the format DOMAIN\username.
-
Environment
-
PGCTLTIMEOUT
-
Default limit on the number of seconds to wait when waiting for startup or shutdown to complete. If not set, the default is 60 seconds.
-
-
PGDATA
-
Default data directory location.
-
大多数 pg_ctl 模式需要知道数据目录位置;因此,除非设置了 PGDATA ,否则 -D 选项是必填的。
Most pg_ctl modes require knowing the data directory location; therefore, the -D option is required unless PGDATA is set.
pg_ctl 与大多数其他 PostgreSQL 实用程序一样,也使用 libpq 支持的环境变量(请参阅 Section 34.15 )。
pg_ctl, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section 34.15).
有关影响服务器的其他变量,请参阅 postgres 。
For additional variables that affect the server, see postgres.
Files
-
postmaster.pid
-
pg_ctl examines this file in the data directory to determine whether the server is currently running.
-
-
postmaster.opts
-
If this file exists in the data directory, pg_ctl (in restart mode) will pass the contents of the file as options to postgres, unless overridden by the -o option. The contents of this file are also displayed in status mode.
-
Examples
Starting the Server
若要启动服务器,请等到服务器可接受连接:
To start the server, waiting until the server is accepting connections:
$ pg_ctl start
若要使用端口 5433 启动服务器,且不使用 fsync ,请使用:
To start the server using port 5433, and running without fsync, use:
$ pg_ctl -o "-F -p 5433" start
Stopping the Server
若要停止服务器,请使用:
To stop the server, use:
$ pg_ctl stop
-m 选项允许对 how 服务器停止进行控制:
The -m option allows control over how the server shuts down:
$ pg_ctl stop -m smart
Restarting the Server
重启服务器几乎等同于停止服务器并重新启动它,只是默认情况下, pg_ctl 会保存之前正在运行实例传递的命令行选项并重复使用它们。若要使用与之前相同的选项重启服务器,请使用:
Restarting the server is almost equivalent to stopping the server and starting it again, except that by default, pg_ctl saves and reuses the command line options that were passed to the previously-running instance. To restart the server using the same options as before, use:
$ pg_ctl restart
但是,如果指定了 -o ,则会替换任何先前的选项。若要使用端口 5433 重启,并在重启后禁用 fsync :
But if -o is specified, that replaces any previous options. To restart using port 5433, disabling fsync upon restart:
$ pg_ctl -o "-F -p 5433" restart
Showing the Server Status
这是 pg_ctl 中一个示例状态输出:
Here is sample status output from 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"
第二行是要在重启模式下调用的命令。
The second line is the command that would be invoked in restart mode.