diff options
author | Peter Eisentraut <peter@eisentraut.org> | 2020-04-02 08:01:30 +0200 |
---|---|---|
committer | Peter Eisentraut <peter@eisentraut.org> | 2020-04-02 08:01:30 +0200 |
commit | 580a446c21f83bcddbaf3ce5f1bab72239c11eb6 (patch) | |
tree | 46c7de72459b17d868079fb0a072ab791d3e132c | |
parent | c6e0edad465e3774401b7f09ad70bd22e5421858 (diff) | |
download | postgresql-580a446c21f83bcddbaf3ce5f1bab72239c11eb6.tar.gz postgresql-580a446c21f83bcddbaf3ce5f1bab72239c11eb6.zip |
doc: Update for Unix-domain sockets on Windows
Update the documentation to reflect that Unix-domain sockets are now
usable on Windows.
-rw-r--r-- | doc/src/sgml/config.sgml | 13 | ||||
-rw-r--r-- | doc/src/sgml/libpq.sgml | 28 | ||||
-rw-r--r-- | doc/src/sgml/ref/pgupgrade.sgml | 2 | ||||
-rw-r--r-- | doc/src/sgml/storage.sgml | 2 |
4 files changed, 22 insertions, 23 deletions
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index 2de21903a15..243d0198689 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -751,6 +751,8 @@ include_dir 'conf.d' only TCP/IP sockets can be used to connect to the server. The default value is normally <filename>/tmp</filename>, but that can be changed at build time. + On Windows, the default is empty, which means no Unix-domain socket is + created by default. This parameter can only be set at server start. </para> @@ -762,11 +764,6 @@ include_dir 'conf.d' created in each of the <varname>unix_socket_directories</varname> directories. Neither file should ever be removed manually. </para> - - <para> - This parameter is irrelevant on Windows, which does not have - Unix-domain sockets. - </para> </listitem> </varlistentry> @@ -789,8 +786,8 @@ include_dir 'conf.d' </para> <para> - This parameter is irrelevant on Windows, which does not have - Unix-domain sockets. + This parameter is not supported on Windows. Any setting will be + ignored. </para> </listitem> </varlistentry> @@ -836,8 +833,6 @@ include_dir 'conf.d' 10, that ignore socket permissions entirely. There, one can achieve a similar effect by pointing <varname>unix_socket_directories</varname> to a directory having search permission limited to the desired audience. - This parameter is also irrelevant on Windows, which does not have - Unix-domain sockets. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index 9a24c19ccbf..c2b3cdabad1 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -959,8 +959,9 @@ postgresql://[2001:db8::1234]/database <para> The host component is interpreted as described for the parameter <xref linkend="libpq-connect-host"/>. In particular, a Unix-domain socket - connection is chosen if the host part is either empty or starts with a - slash, otherwise a TCP/IP connection is initiated. Note, however, that the + connection is chosen if the host part is either empty or looks like an + absolute path name, + otherwise a TCP/IP connection is initiated. Note, however, that the slash is a reserved character in the hierarchical part of the URI. So, to specify a non-standard Unix-domain socket directory, either omit the host specification in the URI and specify the host as a parameter, or @@ -1035,16 +1036,19 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname <term><literal>host</literal></term> <listitem> <para> - Name of host to connect to.<indexterm><primary>host name</primary></indexterm> - If a host name begins with a slash, it specifies Unix-domain - communication rather than TCP/IP communication; the value is the - name of the directory in which the socket file is stored. - The default behavior when <literal>host</literal> is - not specified, or is empty, is to connect to a Unix-domain + Name of host to connect to.<indexterm><primary>host + name</primary></indexterm> If a host name looks like an absolute path + name, it specifies Unix-domain communication rather than TCP/IP + communication; the value is the name of the directory in which the + socket file is stored. (On Unix, an absolute path name begins with a + slash. On Windows, paths starting with drive letters are also + recognized.) The default behavior when <literal>host</literal> is not + specified, or is empty, is to connect to a Unix-domain socket<indexterm><primary>Unix domain socket</primary></indexterm> in <filename>/tmp</filename> (or whatever socket directory was specified - when <productname>PostgreSQL</productname> was built). On machines without - Unix-domain sockets, the default is to connect to <literal>localhost</literal>. + when <productname>PostgreSQL</productname> was built). On Windows and + on machines without Unix-domain sockets, the default is to connect to + <literal>localhost</literal>. </para> <para> A comma-separated list of host names is also accepted, in which case @@ -1123,8 +1127,8 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname </para> <para> Without either a host name or host address, - <application>libpq</application> will connect using a - local Unix-domain socket; or on machines without Unix-domain + <application>libpq</application> will connect using a local + Unix-domain socket; or on Windows and on machines without Unix-domain sockets, it will attempt to connect to <literal>localhost</literal>. </para> </listitem> diff --git a/doc/src/sgml/ref/pgupgrade.sgml b/doc/src/sgml/ref/pgupgrade.sgml index 49de1d57ab2..997ef1e12a4 100644 --- a/doc/src/sgml/ref/pgupgrade.sgml +++ b/doc/src/sgml/ref/pgupgrade.sgml @@ -751,7 +751,7 @@ psql --username=postgres --file=script.sql postgres can use the <option>-s</option> option to put the socket files in some directory with a shorter path name. For security, be sure that that directory is not readable or writable by any other users. - (This is not relevant on Windows.) + (This is not supported on Windows.) </para> <para> diff --git a/doc/src/sgml/storage.sgml b/doc/src/sgml/storage.sgml index 1c19e863d2a..3234adb639f 100644 --- a/doc/src/sgml/storage.sgml +++ b/doc/src/sgml/storage.sgml @@ -169,7 +169,7 @@ last started with</entry> cluster data directory path, postmaster start timestamp, port number, - Unix-domain socket directory path (empty on Windows), + Unix-domain socket directory path (could be empty), first valid listen_address (IP address or <literal>*</literal>, or empty if not listening on TCP), and shared memory segment ID |