Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 140b062

Browse files
tglsfdctglsfdc
committed
Fix alphabetization in catalogs.sgml.
Some recent patches seem not to have grasped the concept that the catalogs are described in alphabetical order.
1 parent 30c36d8 commit 140b062

File tree

1 file changed

+147
-146
lines changed

1 file changed

+147
-146
lines changed

‎doc/src/sgml/catalogs.sgml

Lines changed: 147 additions & 146 deletions
Original file line numberDiff line numberDiff line change
@@ -99,13 +99,13 @@
9999
</row>
100100

101101
<row>
102-
<entry><link linkend="catalog-pg-constraint"><structname>pg_constraint</structname></link></entry>
103-
<entry>check constraints, unique constraints, primary key constraints, foreign key constraints</entry>
102+
<entry><link linkend="catalog-pg-collation"><structname>pg_collation</structname></link></entry>
103+
<entry>collations (locale information)</entry>
104104
</row>
105105

106106
<row>
107-
<entry><link linkend="catalog-pg-collation"><structname>pg_collation</structname></link></entry>
108-
<entry>collations (locale information)</entry>
107+
<entry><link linkend="catalog-pg-constraint"><structname>pg_constraint</structname></link></entry>
108+
<entry>check constraints, unique constraints, primary key constraints, foreign key constraints</entry>
109109
</row>
110110

111111
<row>
@@ -1933,20 +1933,22 @@
19331933
</para>
19341934
</sect1>
19351935

1936-
<sect1 id="catalog-pg-event-trigger">
1937-
<title><structname>pg_event_trigger</structname></title>
1936+
<sect1 id="catalog-pg-collation">
1937+
<title><structname>pg_collation</structname></title>
19381938

1939-
<indexterm zone="catalog-pg-event-trigger">
1940-
<primary>pg_event_trigger</primary>
1939+
<indexterm zone="catalog-pg-collation">
1940+
<primary>pg_collation</primary>
19411941
</indexterm>
19421942

19431943
<para>
1944-
The catalog <structname>pg_event_trigger</structname> stores event triggers.
1945-
See <xref linkend="event-triggers"> for more information.
1944+
The catalog <structname>pg_collation</structname> describes the
1945+
available collations, which are essentially mappings from an SQL
1946+
name to operating system locale categories.
1947+
See <xref linkend="collation"> for more information.
19461948
</para>
19471949

19481950
<table>
1949-
<title><structname>pg_event_trigger</> Columns</title>
1951+
<title><structname>pg_collation</> Columns</title>
19501952

19511953
<tgroup cols="4">
19521954
<thead>
@@ -1960,59 +1962,83 @@
19601962

19611963
<tbody>
19621964
<row>
1963-
<entry><structfield>evtname</structfield></entry>
1964-
<entry><type>name</type></entry>
1965+
<entry><structfield>oid</structfield></entry>
1966+
<entry><type>oid</type></entry>
19651967
<entry></entry>
1966-
<entry>Trigger name (must be unique)</entry>
1968+
<entry>Row identifier (hidden attribute; must be explicitly selected)</entry>
19671969
</row>
19681970

19691971
<row>
1970-
<entry><structfield>evtevent</structfield></entry>
1972+
<entry><structfield>collname</structfield></entry>
19711973
<entry><type>name</type></entry>
19721974
<entry></entry>
1973-
<entry>Identifies the event for which this trigger fires</entry>
1975+
<entry>Collation name (unique per namespace and encoding)</entry>
19741976
</row>
19751977

19761978
<row>
1977-
<entry><structfield>evtowner</structfield></entry>
1979+
<entry><structfield>collnamespace</structfield></entry>
19781980
<entry><type>oid</type></entry>
1979-
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
1980-
<entry>Owner of the event trigger</entry>
1981+
<entry><literal><link linkend="catalog-pg-namespace"><structname>pg_namespace</structname></link>.oid</literal></entry>
1982+
<entry>
1983+
The OID of the namespace that contains this collation
1984+
</entry>
19811985
</row>
19821986

19831987
<row>
1984-
<entry><structfield>evtfoid</structfield></entry>
1988+
<entry><structfield>collowner</structfield></entry>
19851989
<entry><type>oid</type></entry>
1986-
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
1987-
<entry>The function to be called</entry>
1990+
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
1991+
<entry>Owner of the collation</entry>
19881992
</row>
19891993

19901994
<row>
1991-
<entry><structfield>evtenabled</structfield></entry>
1992-
<entry><type>char</type></entry>
1995+
<entry><structfield>collencoding</structfield></entry>
1996+
<entry><type>int4</type></entry>
19931997
<entry></entry>
1994-
<entry>
1995-
Controls in which <xref linkend="guc-session-replication-role"> modes
1996-
the event trigger fires.
1997-
<literal>O</> = trigger fires in <quote>origin</> and <quote>local</> modes,
1998-
<literal>D</> = trigger is disabled,
1999-
<literal>R</> = trigger fires in <quote>replica</> mode,
2000-
<literal>A</> = trigger fires always.
2001-
</entry>
1998+
<entry>Encoding in which the collation is applicable, or -1 if it
1999+
works for any encoding</entry>
20022000
</row>
20032001

20042002
<row>
2005-
<entry><structfield>evttags</structfield></entry>
2006-
<entry><type>text[]</type></entry>
2003+
<entry><structfield>collcollate</structfield></entry>
2004+
<entry><type>name</type></entry>
20072005
<entry></entry>
2008-
<entry>
2009-
Command tags for which this trigger will fire. If NULL, the firing
2010-
of this trigger is not restricted on the basis of the command tag.
2011-
</entry>
2006+
<entry><symbol>LC_COLLATE</> for this collation object</entry>
2007+
</row>
2008+
2009+
<row>
2010+
<entry><structfield>collctype</structfield></entry>
2011+
<entry><type>name</type></entry>
2012+
<entry></entry>
2013+
<entry><symbol>LC_CTYPE</> for this collation object</entry>
20122014
</row>
20132015
</tbody>
20142016
</tgroup>
20152017
</table>
2018+
2019+
<para>
2020+
Note that the unique key on this catalog is (<structfield>collname</>,
2021+
<structfield>collencoding</>, <structfield>collnamespace</>) not just
2022+
(<structfield>collname</>, <structfield>collnamespace</>).
2023+
<productname>PostgreSQL</productname> generally ignores all
2024+
collations that do not have <structfield>collencoding</> equal to
2025+
either the current database's encoding or -1, and creation of new entries
2026+
with the same name as an entry with <structfield>collencoding</> = -1
2027+
is forbidden. Therefore it is sufficient to use a qualified SQL name
2028+
(<replaceable>schema</>.<replaceable>name</>) to identify a collation,
2029+
even though this is not unique according to the catalog definition.
2030+
The reason for defining the catalog this way is that
2031+
<application>initdb</> fills it in at cluster initialization time with
2032+
entries for all locales available on the system, so it must be able to
2033+
hold entries for all encodings that might ever be used in the cluster.
2034+
</para>
2035+
2036+
<para>
2037+
In the <literal>template0</> database, it could be useful to create
2038+
collations whose encoding does not match the database encoding,
2039+
since they could match the encodings of databases later cloned from
2040+
<literal>template0</>. This would currently have to be done manually.
2041+
</para>
20162042
</sect1>
20172043

20182044
<sect1 id="catalog-pg-constraint">
@@ -2296,116 +2322,8 @@
22962322
relation.
22972323
</para>
22982324
</note>
2299-
23002325
</sect1>
23012326

2302-
<sect1 id="catalog-pg-collation">
2303-
<title><structname>pg_collation</structname></title>
2304-
2305-
<indexterm zone="catalog-pg-collation">
2306-
<primary>pg_collation</primary>
2307-
</indexterm>
2308-
2309-
<para>
2310-
The catalog <structname>pg_collation</structname> describes the
2311-
available collations, which are essentially mappings from an SQL
2312-
name to operating system locale categories.
2313-
See <xref linkend="collation"> for more information.
2314-
</para>
2315-
2316-
<table>
2317-
<title><structname>pg_collation</> Columns</title>
2318-
2319-
<tgroup cols="4">
2320-
<thead>
2321-
<row>
2322-
<entry>Name</entry>
2323-
<entry>Type</entry>
2324-
<entry>References</entry>
2325-
<entry>Description</entry>
2326-
</row>
2327-
</thead>
2328-
2329-
<tbody>
2330-
<row>
2331-
<entry><structfield>oid</structfield></entry>
2332-
<entry><type>oid</type></entry>
2333-
<entry></entry>
2334-
<entry>Row identifier (hidden attribute; must be explicitly selected)</entry>
2335-
</row>
2336-
2337-
<row>
2338-
<entry><structfield>collname</structfield></entry>
2339-
<entry><type>name</type></entry>
2340-
<entry></entry>
2341-
<entry>Collation name (unique per namespace and encoding)</entry>
2342-
</row>
2343-
2344-
<row>
2345-
<entry><structfield>collnamespace</structfield></entry>
2346-
<entry><type>oid</type></entry>
2347-
<entry><literal><link linkend="catalog-pg-namespace"><structname>pg_namespace</structname></link>.oid</literal></entry>
2348-
<entry>
2349-
The OID of the namespace that contains this collation
2350-
</entry>
2351-
</row>
2352-
2353-
<row>
2354-
<entry><structfield>collowner</structfield></entry>
2355-
<entry><type>oid</type></entry>
2356-
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
2357-
<entry>Owner of the collation</entry>
2358-
</row>
2359-
2360-
<row>
2361-
<entry><structfield>collencoding</structfield></entry>
2362-
<entry><type>int4</type></entry>
2363-
<entry></entry>
2364-
<entry>Encoding in which the collation is applicable, or -1 if it
2365-
works for any encoding</entry>
2366-
</row>
2367-
2368-
<row>
2369-
<entry><structfield>collcollate</structfield></entry>
2370-
<entry><type>name</type></entry>
2371-
<entry></entry>
2372-
<entry><symbol>LC_COLLATE</> for this collation object</entry>
2373-
</row>
2374-
2375-
<row>
2376-
<entry><structfield>collctype</structfield></entry>
2377-
<entry><type>name</type></entry>
2378-
<entry></entry>
2379-
<entry><symbol>LC_CTYPE</> for this collation object</entry>
2380-
</row>
2381-
</tbody>
2382-
</tgroup>
2383-
</table>
2384-
2385-
<para>
2386-
Note that the unique key on this catalog is (<structfield>collname</>,
2387-
<structfield>collencoding</>, <structfield>collnamespace</>) not just
2388-
(<structfield>collname</>, <structfield>collnamespace</>).
2389-
<productname>PostgreSQL</productname> generally ignores all
2390-
collations that do not have <structfield>collencoding</> equal to
2391-
either the current database's encoding or -1, and creation of new entries
2392-
with the same name as an entry with <structfield>collencoding</> = -1
2393-
is forbidden. Therefore it is sufficient to use a qualified SQL name
2394-
(<replaceable>schema</>.<replaceable>name</>) to identify a collation,
2395-
even though this is not unique according to the catalog definition.
2396-
The reason for defining the catalog this way is that
2397-
<application>initdb</> fills it in at cluster initialization time with
2398-
entries for all locales available on the system, so it must be able to
2399-
hold entries for all encodings that might ever be used in the cluster.
2400-
</para>
2401-
2402-
<para>
2403-
In the <literal>template0</> database, it could be useful to create
2404-
collations whose encoding does not match the database encoding,
2405-
since they could match the encodings of databases later cloned from
2406-
<literal>template0</>. This would currently have to be done manually.
2407-
</para>
2408-
</sect1>
24092327

24102328
<sect1 id="catalog-pg-conversion">
24112329
<title><structname>pg_conversion</structname></title>
@@ -3178,6 +3096,89 @@
31783096
</sect1>
31793097

31803098

3099+
<sect1 id="catalog-pg-event-trigger">
3100+
<title><structname>pg_event_trigger</structname></title>
3101+
3102+
<indexterm zone="catalog-pg-event-trigger">
3103+
<primary>pg_event_trigger</primary>
3104+
</indexterm>
3105+
3106+
<para>
3107+
The catalog <structname>pg_event_trigger</structname> stores event triggers.
3108+
See <xref linkend="event-triggers"> for more information.
3109+
</para>
3110+
3111+
<table>
3112+
<title><structname>pg_event_trigger</> Columns</title>
3113+
3114+
<tgroup cols="4">
3115+
<thead>
3116+
<row>
3117+
<entry>Name</entry>
3118+
<entry>Type</entry>
3119+
<entry>References</entry>
3120+
<entry>Description</entry>
3121+
</row>
3122+
</thead>
3123+
3124+
<tbody>
3125+
<row>
3126+
<entry><structfield>evtname</structfield></entry>
3127+
<entry><type>name</type></entry>
3128+
<entry></entry>
3129+
<entry>Trigger name (must be unique)</entry>
3130+
</row>
3131+
3132+
<row>
3133+
<entry><structfield>evtevent</structfield></entry>
3134+
<entry><type>name</type></entry>
3135+
<entry></entry>
3136+
<entry>Identifies the event for which this trigger fires</entry>
3137+
</row>
3138+
3139+
<row>
3140+
<entry><structfield>evtowner</structfield></entry>
3141+
<entry><type>oid</type></entry>
3142+
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
3143+
<entry>Owner of the event trigger</entry>
3144+
</row>
3145+
3146+
<row>
3147+
<entry><structfield>evtfoid</structfield></entry>
3148+
<entry><type>oid</type></entry>
3149+
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
3150+
<entry>The function to be called</entry>
3151+
</row>
3152+
3153+
<row>
3154+
<entry><structfield>evtenabled</structfield></entry>
3155+
<entry><type>char</type></entry>
3156+
<entry></entry>
3157+
<entry>
3158+
Controls in which <xref linkend="guc-session-replication-role"> modes
3159+
the event trigger fires.
3160+
<literal>O</> = trigger fires in <quote>origin</> and <quote>local</> modes,
3161+
<literal>D</> = trigger is disabled,
3162+
<literal>R</> = trigger fires in <quote>replica</> mode,
3163+
<literal>A</> = trigger fires always.
3164+
</entry>
3165+
</row>
3166+
3167+
<row>
3168+
<entry><structfield>evttags</structfield></entry>
3169+
<entry><type>text[]</type></entry>
3170+
<entry></entry>
3171+
<entry>
3172+
Command tags for which this trigger will fire. If NULL, the firing
3173+
of this trigger is not restricted on the basis of the command tag.
3174+
</entry>
3175+
</row>
3176+
</tbody>
3177+
</tgroup>
3178+
</table>
3179+
</sect1>
3180+
3181+
31813182
<sect1 id="catalog-pg-extension">
31823183
<title><structname>pg_extension</structname></title>
31833184

0 commit comments

Comments
 (0)