Skip to content

Commit 9a50f2e

Browse files
committed
doc: Update ALTER COLLATION wording
The original text on refreshing collation versions was written specifically for ICU, and then information for other providers was incrementally tacked on at the end. Reword this to be a bit more general and less reflective of how it was added.
1 parent eabcfd9 commit 9a50f2e

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

doc/src/sgml/ref/alter_collation.sgml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,9 @@ ALTER COLLATION <replaceable>name</replaceable> SET SCHEMA <replaceable>new_sche
104104
<title>Notes</title>
105105

106106
<para>
107-
When using collations provided by the ICU library, the ICU-specific version
108-
of the collator is recorded in the system catalog when the collation object
109-
is created. When the collation is used, the current version is
107+
When a collation object is created, the provider-specific version of the
108+
collation is recorded in the system catalog. When the collation is used,
109+
the current version is
110110
checked against the recorded version, and a warning is issued when there is
111111
a mismatch, for example:
112112
<screen>
@@ -117,21 +117,24 @@ HINT: Rebuild all objects affected by this collation and run ALTER COLLATION pg
117117
A change in collation definitions can lead to corrupt indexes and other
118118
problems because the database system relies on stored objects having a
119119
certain sort order. Generally, this should be avoided, but it can happen
120-
in legitimate circumstances, such as when
120+
in legitimate circumstances, such as when upgrading the operating system
121+
to a new major version or when
121122
using <command>pg_upgrade</command> to upgrade to server binaries linked
122123
with a newer version of ICU. When this happens, all objects depending on
123124
the collation should be rebuilt, for example,
124125
using <command>REINDEX</command>. When that is done, the collation version
125126
can be refreshed using the command <literal>ALTER COLLATION ... REFRESH
126127
VERSION</literal>. This will update the system catalog to record the
127-
current collator version and will make the warning go away. Note that this
128+
current collation version and will make the warning go away. Note that this
128129
does not actually check whether all affected objects have been rebuilt
129130
correctly.
130131
</para>
131132
<para>
132133
When using collations provided by <literal>libc</literal>, version
133134
information is recorded on systems using the GNU C library (most Linux
134-
systems), FreeBSD and Windows.
135+
systems), FreeBSD and Windows. When using collations provided by ICU, the
136+
version information is provided by the ICU library and is available on all
137+
platforms.
135138
</para>
136139
<note>
137140
<para>

0 commit comments

Comments
 (0)