Skip to content

Commit 580a446

Browse files
committed
doc: Update for Unix-domain sockets on Windows
Update the documentation to reflect that Unix-domain sockets are now usable on Windows.
1 parent c6e0eda commit 580a446

File tree

4 files changed

+22
-23
lines changed

4 files changed

+22
-23
lines changed

doc/src/sgml/config.sgml

+4-9
Original file line numberDiff line numberDiff line change
@@ -751,6 +751,8 @@ include_dir 'conf.d'
751751
only TCP/IP sockets can be used to connect to the server.
752752
The default value is normally
753753
<filename>/tmp</filename>, but that can be changed at build time.
754+
On Windows, the default is empty, which means no Unix-domain socket is
755+
created by default.
754756
This parameter can only be set at server start.
755757
</para>
756758

@@ -762,11 +764,6 @@ include_dir 'conf.d'
762764
created in each of the <varname>unix_socket_directories</varname> directories.
763765
Neither file should ever be removed manually.
764766
</para>
765-
766-
<para>
767-
This parameter is irrelevant on Windows, which does not have
768-
Unix-domain sockets.
769-
</para>
770767
</listitem>
771768
</varlistentry>
772769

@@ -789,8 +786,8 @@ include_dir 'conf.d'
789786
</para>
790787

791788
<para>
792-
This parameter is irrelevant on Windows, which does not have
793-
Unix-domain sockets.
789+
This parameter is not supported on Windows. Any setting will be
790+
ignored.
794791
</para>
795792
</listitem>
796793
</varlistentry>
@@ -836,8 +833,6 @@ include_dir 'conf.d'
836833
10, that ignore socket permissions entirely. There, one can achieve a
837834
similar effect by pointing <varname>unix_socket_directories</varname> to a
838835
directory having search permission limited to the desired audience.
839-
This parameter is also irrelevant on Windows, which does not have
840-
Unix-domain sockets.
841836
</para>
842837
</listitem>
843838
</varlistentry>

doc/src/sgml/libpq.sgml

+16-12
Original file line numberDiff line numberDiff line change
@@ -959,8 +959,9 @@ postgresql://[2001:db8::1234]/database
959959
<para>
960960
The host component is interpreted as described for the parameter <xref
961961
linkend="libpq-connect-host"/>. In particular, a Unix-domain socket
962-
connection is chosen if the host part is either empty or starts with a
963-
slash, otherwise a TCP/IP connection is initiated. Note, however, that the
962+
connection is chosen if the host part is either empty or looks like an
963+
absolute path name,
964+
otherwise a TCP/IP connection is initiated. Note, however, that the
964965
slash is a reserved character in the hierarchical part of the URI. So, to
965966
specify a non-standard Unix-domain socket directory, either omit the host
966967
specification in the URI and specify the host as a parameter, or
@@ -1035,16 +1036,19 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
10351036
<term><literal>host</literal></term>
10361037
<listitem>
10371038
<para>
1038-
Name of host to connect to.<indexterm><primary>host name</primary></indexterm>
1039-
If a host name begins with a slash, it specifies Unix-domain
1040-
communication rather than TCP/IP communication; the value is the
1041-
name of the directory in which the socket file is stored.
1042-
The default behavior when <literal>host</literal> is
1043-
not specified, or is empty, is to connect to a Unix-domain
1039+
Name of host to connect to.<indexterm><primary>host
1040+
name</primary></indexterm> If a host name looks like an absolute path
1041+
name, it specifies Unix-domain communication rather than TCP/IP
1042+
communication; the value is the name of the directory in which the
1043+
socket file is stored. (On Unix, an absolute path name begins with a
1044+
slash. On Windows, paths starting with drive letters are also
1045+
recognized.) The default behavior when <literal>host</literal> is not
1046+
specified, or is empty, is to connect to a Unix-domain
10441047
socket<indexterm><primary>Unix domain socket</primary></indexterm> in
10451048
<filename>/tmp</filename> (or whatever socket directory was specified
1046-
when <productname>PostgreSQL</productname> was built). On machines without
1047-
Unix-domain sockets, the default is to connect to <literal>localhost</literal>.
1049+
when <productname>PostgreSQL</productname> was built). On Windows and
1050+
on machines without Unix-domain sockets, the default is to connect to
1051+
<literal>localhost</literal>.
10481052
</para>
10491053
<para>
10501054
A comma-separated list of host names is also accepted, in which case
@@ -1123,8 +1127,8 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
11231127
</para>
11241128
<para>
11251129
Without either a host name or host address,
1126-
<application>libpq</application> will connect using a
1127-
local Unix-domain socket; or on machines without Unix-domain
1130+
<application>libpq</application> will connect using a local
1131+
Unix-domain socket; or on Windows and on machines without Unix-domain
11281132
sockets, it will attempt to connect to <literal>localhost</literal>.
11291133
</para>
11301134
</listitem>

doc/src/sgml/ref/pgupgrade.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -751,7 +751,7 @@ psql --username=postgres --file=script.sql postgres
751751
can use the <option>-s</option> option to put the socket files in some
752752
directory with a shorter path name. For security, be sure that that
753753
directory is not readable or writable by any other users.
754-
(This is not relevant on Windows.)
754+
(This is not supported on Windows.)
755755
</para>
756756

757757
<para>

doc/src/sgml/storage.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ last started with</entry>
169169
cluster data directory path,
170170
postmaster start timestamp,
171171
port number,
172-
Unix-domain socket directory path (empty on Windows),
172+
Unix-domain socket directory path (could be empty),
173173
first valid listen_address (IP address or <literal>*</literal>, or empty if
174174
not listening on TCP),
175175
and shared memory segment ID

0 commit comments

Comments
 (0)