Movatterモバイル変換


[0]ホーム

URL:



Facebook
Postgres Pro
Facebook
Downloads
postgres
Prev UpPostgres Pro Server ApplicationsHome Next

postgres

postgres —Postgres Pro database server

Synopsis

postgres [option...]

Description

postgres is thePostgres Pro database server. In order for a client application to access a database it connects (over a network or locally) to a runningpostgres instance. Thepostgres instance then starts a separate server process to handle the connection.

Onepostgres instance always manages the data of exactly one database cluster. A database cluster is a collection of databases that is stored at a common file system location (thedata area). More than onepostgres instance can run on a system at one time, so long as they use different data areas and different communication ports (see below). Whenpostgres starts it needs to know the location of the data area. The location must be specified by the-D option or thePGDATA environment variable; there is no default. Typically,-D orPGDATA points directly to the data area directory created byinitdb. Other possible file layouts are discussed inSection 18.2.

By defaultpostgres starts in the foreground and prints log messages to the standard error stream. In practical applicationspostgres should be started as a background process, perhaps at boot time.

Thepostgres command can also be called in single-user mode. The primary use for this mode is during bootstrapping byinitdb. Sometimes it is used for debugging or disaster recovery; note that running a single-user server is not truly suitable for debugging the server, since no realistic interprocess communication and locking will happen. When invoked in single-user mode from the shell, the user can enter queries and the results will be printed to the screen, but in a form that is more useful for developers than end users. In the single-user mode, the session user will be set to the user with ID 1, and implicit superuser powers are granted to this user. This user does not actually have to exist, so the single-user mode can be used to manually recover from certain kinds of accidental damage to the system catalogs.

Options#

postgres accepts the following command-line arguments. For a detailed discussion of the options consultChapter 18. You can save typing most of these options by setting up a configuration file. Some (safe) options can also be set from the connecting client in an application-dependent way to apply only for that session. For example, if the environment variablePGOPTIONS is set, thenlibpq-based clients will pass that string to the server, which will interpret it aspostgres command-line options.

General Purpose

-Bnbuffers

Sets the number of shared buffers for use by the server processes. The default value of this parameter is chosen automatically byinitdb. Specifying this option is equivalent to setting theshared_buffers configuration parameter.

-cname=value

Sets a named run-time parameter. The configuration parameters supported byPostgres Pro are described inChapter 18. Most of the other command line options are in fact short forms of such a parameter assignment.-c can appear multiple times to set multiple parameters.

-Cname

Prints the value of the named run-time parameter, and exits. (See the-c option above for details.) This returns values frompostgresql.conf, modified by any parameters supplied in this invocation. It does not reflect parameters supplied when the cluster was started.

This can be used on a running server for most parameters. However, the server must be shut down for some runtime-computed parameters (e.g.,shared_memory_size,shared_memory_size_in_huge_pages, andwal_segment_size).

This option is meant for other programs that interact with a server instance, such aspg_ctl, to query configuration parameter values. User-facing applications should instead useSHOW or thepg_settings view.

-ddebug-level

Sets the debug level. The higher this value is set, the more debugging output is written to the server log. Values are from 1 to 5. It is also possible to pass-d 0 for a specific session, which will prevent the server log level of the parentpostgres process from being propagated to this session.

-Ddatadir

Specifies the file system location of the database configuration files. SeeSection 18.2 for details.

-e

Sets the default date style toEuropean, that isDMY ordering of input date fields. This also causes the day to be printed before the month in certain date output formats. SeeSection 8.5 for more information.

-F

Disablesfsync calls for improved performance, at the risk of data corruption in the event of a system crash. Specifying this option is equivalent to disabling thefsync configuration parameter. Read the detailed documentation before using this!

-hhostname

Specifies the IP host name or address on whichpostgres is to listen for TCP/IP connections from client applications. The value can also be a comma-separated list of addresses, or* to specify listening on all available interfaces. An empty value specifies not listening on any IP addresses, in which case only Unix-domain sockets can be used to connect to the server. Defaults to listening only onlocalhost. Specifying this option is equivalent to setting thelisten_addresses configuration parameter.

-i

Allows remote clients to connect via TCP/IP (Internet domain) connections. Without this option, only local connections are accepted. This option is equivalent to settinglisten_addresses to* inpostgresql.conf or via-h.

This option is deprecated since it does not allow access to the full functionality oflisten_addresses. It's usually better to setlisten_addresses directly.

-kdirectory

Specifies the directory of the Unix-domain socket on whichpostgres is to listen for connections from client applications. The value can also be a comma-separated list of directories. An empty value specifies not listening on any Unix-domain sockets, in which case only TCP/IP sockets can be used to connect to the server. The default value is normally/tmp, but that can be changed at build time. Specifying this option is equivalent to setting theunix_socket_directories configuration parameter.

-l

Enables secure connections usingSSL.Postgres Pro must have been compiled with support forSSL for this option to be available. For more information on usingSSL, refer toSection 17.9.

-Nmax-connections

Sets the maximum number of client connections that this server will accept. The default value of this parameter is chosen automatically byinitdb. Specifying this option is equivalent to setting themax_connections configuration parameter.

-pport

Specifies the TCP/IP port or local Unix domain socket file extension on whichpostgres is to listen for connections from client applications. Defaults to the value of thePGPORT environment variable, or ifPGPORT is not set, then defaults to the value established during compilation (normally 5432). If you specify a port other than the default port, then all client applications must specify the same port using either command-line options orPGPORT.

-s

Print time information and other statistics at the end of each command. This is useful for benchmarking or for use in tuning the number of buffers.

-Swork-mem

Specifies the base amount of memory to be used by sorts and hash tables before resorting to temporary disk files. See the description of thework_mem configuration parameter inSection 18.4.1.

-V
--version

Print thepostgres version and exit.

--name=value

Sets a named run-time parameter; a shorter form of-c.

--describe-config

This option dumps out the server's internal configuration variables, descriptions, and defaults in tab-delimitedCOPY format. It is designed primarily for use by administration tools.

-?
--help

Show help aboutpostgres command line arguments, and exit.

Semi-Internal Options

The options described here are used mainly for debugging purposes, and in some cases to assist with recovery of severely damaged databases. There should be no reason to use them in a production database setup. They are listed here only for use byPostgres Pro system developers. Furthermore, these options might change or be removed in a future release without notice.

-f{ s | i | o | b | t | n | m | h }

Forbids the use of particular scan and join methods:s andi disable sequential and index scans respectively,o,b andt disable index-only scans, bitmap index scans, and TID scans respectively, whilen,m, andh disable nested-loop, merge and hash joins respectively.

Neither sequential scans nor nested-loop joins can be disabled completely; the-fs and-fn options simply discourage the optimizer from using those plan types if it has any other alternative.

-O

Allows the structure of system tables to be modified. This is used byinitdb.

-P

Ignore system indexes when reading system tables, but still update the indexes when modifying the tables. This is useful when recovering from damaged system indexes.

-tpa[rser] | pl[anner] | e[xecutor]

Print timing statistics for each query relating to each of the major system modules. This option cannot be used together with the-s option.

-T

This option is for debugging problems that cause a server process to die abnormally. The ordinary strategy in this situation is to notify all other server processes that they must terminate, by sending themSIGQUIT signals. With this option,SIGABRT will be sent instead, resulting in production of core dump files.

-vprotocol

Specifies the version number of the frontend/backend protocol to be used for a particular session. This option is for internal use only.

-Wseconds

A delay of this many seconds occurs when a new server process is started, after it conducts the authentication procedure. This is intended to give an opportunity to attach to the server process with a debugger.

-Z

Verifies that the currentpostgres binary is compatible with the specified cluster. If the architecture type or any compilation options that affect cluster compatibility do not match, returns an exit status of 1 and provides an error message specifying the first detected incompatibility. Otherwise, reports success and exits without starting the cluster.

You must provide the path to the data directory of the cluster to check.

The cluster and the binary must have the same byte order and architecture type for this option to work correctly.

Tip

If the binary appears to be incompatible with the specified cluster, runpgpro_controldata with the-P or-C command-line argument to view all parameters of the cluster that affect the compatibility.

Options for Single-User Mode

The following options only apply to the single-user mode (seeSingle-User Mode below).

--single

Selects the single-user mode. This must be the first argument on the command line.

database

Specifies the name of the database to be accessed. This must be the last argument on the command line. If it is omitted it defaults to the user name.

-E

Echo all commands to standard output before executing them.

-j

Use semicolon followed by two newlines, rather than just newline, as the command entry terminator.

-rfilename

Send all server log output tofilename. This option is only honored when supplied as a command-line option.

Environment

PGCLIENTENCODING

Default character encoding used by clients. (The clients can override this individually.) This value can also be set in the configuration file.

PGDATA

Default data directory location

PGDATESTYLE

Default value of theDateStyle run-time parameter. (The use of this environment variable is deprecated.)

PGPORT

Default port number (preferably set in the configuration file)

Diagnostics

A failure message mentioningsemget orshmget probably indicates you need to configure your kernel to provide adequate shared memory and semaphores. For more discussion seeSection 17.4. You might be able to postpone reconfiguring your kernel by decreasingshared_buffers to reduce the shared memory consumption ofPostgres Pro, and/or by reducingmax_connections to reduce the semaphore consumption.

A failure message suggesting that another server is already running should be checked carefully, for example by using the command

$ps ax | grep postgres

or

$ps -ef | grep postgres

depending on your system. If you are certain that no conflicting server is running, you can remove the lock file mentioned in the message and try again.

A failure message indicating inability to bind to a port might indicate that that port is already in use by some non-Postgres Pro process. You might also get this error if you terminatepostgres and immediately restart it using the same port; in this case, you must simply wait a few seconds until the operating system closes the port before trying again. Finally, you might get this error if you specify a port number that your operating system considers to be reserved. For example, many versions of Unix consider port numbers under 1024 to betrusted and only permit the Unix superuser to access them.

Notes

The utility commandpg_ctl can be used to start and shut down thepostgres server safely and comfortably.

If at all possible,do not useSIGKILL to kill the mainpostgres server. Doing so will preventpostgres from freeing the system resources (e.g., shared memory and semaphores) that it holds before terminating. This might cause problems for starting a freshpostgres run.

To terminate thepostgres server normally, the signalsSIGTERM,SIGINT, orSIGQUIT can be used. The first will wait for all clients to terminate before quitting, the second will forcefully disconnect all clients, and the third will quit immediately without proper shutdown, resulting in a recovery run during restart.

TheSIGHUP signal will reload the server configuration files. It is also possible to sendSIGHUP to an individual server process, but that is usually not sensible.

To cancel a running query, send theSIGINT signal to the process running that command. To terminate a backend process cleanly, sendSIGTERM to that process. See alsopg_cancel_backend andpg_terminate_backend inSection 9.28.2 for the SQL-callable equivalents of these two actions.

Thepostgres server usesSIGQUIT to tell subordinate server processes to terminate without normal cleanup. This signalshould not be used by users. It is also unwise to sendSIGKILL to a server process — the mainpostgres process will interpret this as a crash and will force all the sibling processes to quit as part of its standard crash-recovery procedure.

Bugs#

The-- options will not work onFreeBSD orOpenBSD. Use-c instead. This is a bug in the affected operating systems; a future release ofPostgres Pro will provide a workaround if this is not fixed.

Single-User Mode#

To start a single-user mode server, use a command like

postgres --single -D /usr/local/pgsql/dataother-options my_database

Provide the correct path to the database directory with-D, or make sure that the environment variablePGDATA is set. Also specify the name of the particular database you want to work in.

Normally, the single-user mode server treats newline as the command entry terminator; there is no intelligence about semicolons, as there is inpsql. To continue a command across multiple lines, you must type backslash just before each newline except the last one. The backslash and adjacent newline are both dropped from the input command. Note that this will happen even when within a string literal or comment.

But if you use the-j command line switch, a single newline does not terminate command entry; instead, the sequence semicolon-newline-newline does. That is, type a semicolon immediately followed by a completely empty line. Backslash-newline is not treated specially in this mode. Again, there is no intelligence about such a sequence appearing within a string literal or comment.

In either input mode, if you type a semicolon that is not just before or part of a command entry terminator, it is considered a command separator. When you do type a command entry terminator, the multiple statements you've entered will be executed as a single transaction.

To quit the session, typeEOF (Control+D, usually). If you've entered any text since the last command entry terminator, thenEOF will be taken as a command entry terminator, and anotherEOF will be needed to exit.

Note that the single-user mode server does not provide sophisticated line-editing features (no command history, for example). Single-user mode also does not do any background processing, such as automatic checkpoints or replication.

Examples#

To startpostgres in the background using default values, type:

$nohup postgres >logfile 2>&1 </dev/null &

To startpostgres with a specific port, e.g., 1234:

$postgres -p 1234

To connect to this server usingpsql, specify this port with the -p option:

$psql -p 1234

or set the environment variablePGPORT:

$export PGPORT=1234$psql

Named run-time parameters can be set in either of these styles:

$postgres -c work_mem=1234$postgres --work-mem=1234

Either form overrides whatever setting might exist forwork_mem inpostgresql.conf. Notice that underscores in parameter names can be written as either underscore or dash on the command line. Except for short-term experiments, it's probably better practice to edit the setting inpostgresql.conf than to rely on a command-line switch to set a parameter.

See Also

initdb,pg_ctl


Prev Up Next
pg_walsummary Home Part VII. Internals
pdfepub
Go to Postgres Pro Standard 17
By continuing to browse this website, you agree to the use of cookies. Go toPrivacy Policy.

[8]ページ先頭

©2009-2025 Movatter.jp