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

Commit 20a1b9e

Browse files
bmomjianbmomjian
committed
Add contrib function references in the doc index
Backpatch to 9.3. Idea from Craig Ringer
1 parent 6bc8ef0 commit 20a1b9e

20 files changed

+376
-75
lines changed

‎doc/src/sgml/dblink.sgml

+76
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@
2929
<refpurpose>opens a persistent connection to a remote database</refpurpose>
3030
</refnamediv>
3131

32+
<indexterm>
33+
<primary>dblink_connect</primary>
34+
</indexterm>
35+
3236
<refsynopsisdiv>
3337
<synopsis>
3438
dblink_connect(text connstr) returns text
@@ -189,6 +193,10 @@ DROP SERVER fdtest;
189193
<refpurpose>opens a persistent connection to a remote database, insecurely</refpurpose>
190194
</refnamediv>
191195

196+
<indexterm>
197+
<primary>dblink_connect_u</primary>
198+
</indexterm>
199+
192200
<refsynopsisdiv>
193201
<synopsis>
194202
dblink_connect_u(text connstr) returns text
@@ -242,6 +250,10 @@ dblink_connect_u(text connname, text connstr) returns text
242250
<refpurpose>closes a persistent connection to a remote database</refpurpose>
243251
</refnamediv>
244252

253+
<indexterm>
254+
<primary>dblink_disconnect</primary>
255+
</indexterm>
256+
245257
<refsynopsisdiv>
246258
<synopsis>
247259
dblink_disconnect() returns text
@@ -313,6 +325,10 @@ SELECT dblink_disconnect('myconn');
313325
<refpurpose>executes a query in a remote database</refpurpose>
314326
</refnamediv>
315327

328+
<indexterm>
329+
<primary>dblink</primary>
330+
</indexterm>
331+
316332
<refsynopsisdiv>
317333
<synopsis>
318334
dblink(text connname, text sql [, bool fail_on_error]) returns setof record
@@ -527,6 +543,10 @@ SELECT * FROM dblink('myconn', 'select proname, prosrc from pg_proc')
527543
<refpurpose>executes a command in a remote database</refpurpose>
528544
</refnamediv>
529545

546+
<indexterm>
547+
<primary>dblink_exec</primary>
548+
</indexterm>
549+
530550
<refsynopsisdiv>
531551
<synopsis>
532552
dblink_exec(text connname, text sql [, bool fail_on_error]) returns text
@@ -660,6 +680,10 @@ DETAIL: ERROR: null value in column "relnamespace" violates not-null constrain
660680
<refpurpose>opens a cursor in a remote database</refpurpose>
661681
</refnamediv>
662682

683+
<indexterm>
684+
<primary>dblink_open</primary>
685+
</indexterm>
686+
663687
<refsynopsisdiv>
664688
<synopsis>
665689
dblink_open(text cursorname, text sql [, bool fail_on_error]) returns text
@@ -780,6 +804,10 @@ SELECT dblink_open('foo', 'select proname, prosrc from pg_proc');
780804
<refpurpose>returns rows from an open cursor in a remote database</refpurpose>
781805
</refnamediv>
782806

807+
<indexterm>
808+
<primary>dblink_fetch</primary>
809+
</indexterm>
810+
783811
<refsynopsisdiv>
784812
<synopsis>
785813
dblink_fetch(text cursorname, int howmany [, bool fail_on_error]) returns setof record
@@ -929,6 +957,10 @@ SELECT * FROM dblink_fetch('foo', 5) AS (funcname name, source text);
929957
<refpurpose>closes a cursor in a remote database</refpurpose>
930958
</refnamediv>
931959

960+
<indexterm>
961+
<primary>dblink_close</primary>
962+
</indexterm>
963+
932964
<refsynopsisdiv>
933965
<synopsis>
934966
dblink_close(text cursorname [, bool fail_on_error]) returns text
@@ -1036,6 +1068,10 @@ SELECT dblink_close('foo');
10361068
<refpurpose>returns the names of all open named dblink connections</refpurpose>
10371069
</refnamediv>
10381070

1071+
<indexterm>
1072+
<primary>dblink_get_connections</primary>
1073+
</indexterm>
1074+
10391075
<refsynopsisdiv>
10401076
<synopsis>
10411077
dblink_get_connections() returns text[]
@@ -1077,6 +1113,10 @@ SELECT dblink_get_connections();
10771113
<refpurpose>gets last error message on the named connection</refpurpose>
10781114
</refnamediv>
10791115

1116+
<indexterm>
1117+
<primary>dblink_error_message</primary>
1118+
</indexterm>
1119+
10801120
<refsynopsisdiv>
10811121
<synopsis>
10821122
dblink_error_message(text connname) returns text
@@ -1136,6 +1176,10 @@ SELECT dblink_error_message('dtest1');
11361176
<refpurpose>sends an async query to a remote database</refpurpose>
11371177
</refnamediv>
11381178

1179+
<indexterm>
1180+
<primary>dblink_send_query</primary>
1181+
</indexterm>
1182+
11391183
<refsynopsisdiv>
11401184
<synopsis>
11411185
dblink_send_query(text connname, text sql) returns int
@@ -1214,6 +1258,10 @@ SELECT dblink_send_query('dtest1', 'SELECT * FROM foo WHERE f1 &lt; 3');
12141258
<refpurpose>checks if connection is busy with an async query</refpurpose>
12151259
</refnamediv>
12161260

1261+
<indexterm>
1262+
<primary>dblink_is_busy</primary>
1263+
</indexterm>
1264+
12171265
<refsynopsisdiv>
12181266
<synopsis>
12191267
dblink_is_busy(text connname) returns int
@@ -1273,6 +1321,10 @@ SELECT dblink_is_busy('dtest1');
12731321
<refpurpose>retrieve async notifications on a connection</refpurpose>
12741322
</refnamediv>
12751323

1324+
<indexterm>
1325+
<primary>dblink_get_notify</primary>
1326+
</indexterm>
1327+
12761328
<refsynopsisdiv>
12771329
<synopsis>
12781330
dblink_get_notify() returns setof (notify_name text, be_pid int, extra text)
@@ -1351,6 +1403,10 @@ SELECT * FROM dblink_get_notify();
13511403
<refpurpose>gets an async query result</refpurpose>
13521404
</refnamediv>
13531405

1406+
<indexterm>
1407+
<primary>dblink_get_result</primary>
1408+
</indexterm>
1409+
13541410
<refsynopsisdiv>
13551411
<synopsis>
13561412
dblink_get_result(text connname [, bool fail_on_error]) returns setof record
@@ -1511,6 +1567,10 @@ contrib_regression=# SELECT * FROM dblink_get_result('dtest1') AS t1(f1 int, f2
15111567
<refpurpose>cancels any active query on the named connection</refpurpose>
15121568
</refnamediv>
15131569

1570+
<indexterm>
1571+
<primary>dblink_cancel_query</primary>
1572+
</indexterm>
1573+
15141574
<refsynopsisdiv>
15151575
<synopsis>
15161576
dblink_cancel_query(text connname) returns text
@@ -1577,6 +1637,10 @@ SELECT dblink_cancel_query('dtest1');
15771637
</refpurpose>
15781638
</refnamediv>
15791639

1640+
<indexterm>
1641+
<primary>dblink_get_pkey</primary>
1642+
</indexterm>
1643+
15801644
<refsynopsisdiv>
15811645
<synopsis>
15821646
dblink_get_pkey(text relname) returns setof dblink_pkey_results
@@ -1666,6 +1730,10 @@ SELECT * FROM dblink_get_pkey('foobar');
16661730
</refpurpose>
16671731
</refnamediv>
16681732

1733+
<indexterm>
1734+
<primary>dblink_build_sql_insert</primary>
1735+
</indexterm>
1736+
16691737
<refsynopsisdiv>
16701738
<synopsis>
16711739
dblink_build_sql_insert(text relname,
@@ -1796,6 +1864,10 @@ SELECT dblink_build_sql_insert('foo', '1 2', 2, '{"1", "a"}', '{"1", "b''a"}');
17961864
</refpurpose>
17971865
</refnamediv>
17981866

1867+
<indexterm>
1868+
<primary>dblink_build_sql_delete</primary>
1869+
</indexterm>
1870+
17991871
<refsynopsisdiv>
18001872
<synopsis>
18011873
dblink_build_sql_delete(text relname,
@@ -1910,6 +1982,10 @@ SELECT dblink_build_sql_delete('"MyFoo"', '1 2', 2, '{"1", "b"}');
19101982
</refpurpose>
19111983
</refnamediv>
19121984

1985+
<indexterm>
1986+
<primary>dblink_build_sql_update</primary>
1987+
</indexterm>
1988+
19131989
<refsynopsisdiv>
19141990
<synopsis>
19151991
dblink_build_sql_update(text relname,

‎doc/src/sgml/earthdistance.sgml

+8-8
Original file line numberDiff line numberDiff line change
@@ -71,56 +71,56 @@
7171
</thead>
7272
<tbody>
7373
<row>
74-
<entry><function>earth()</function></entry>
74+
<entry><function>earth()</function><indexterm><primary>earth</primary></indexterm></entry>
7575
<entry><type>float8</type></entry>
7676
<entry>Returns the assumed radius of the Earth.</entry>
7777
</row>
7878
<row>
79-
<entry><function>sec_to_gc(float8)</function></entry>
79+
<entry><function>sec_to_gc(float8)</function><indexterm><primary>sec_to_gc</primary></indexterm></entry>
8080
<entry><type>float8</type></entry>
8181
<entry>Converts the normal straight line
8282
(secant) distance between two points on the surface of the Earth
8383
to the great circle distance between them.
8484
</entry>
8585
</row>
8686
<row>
87-
<entry><function>gc_to_sec(float8)</function></entry>
87+
<entry><function>gc_to_sec(float8)</function><indexterm><primary>gc_to_sec</primary></indexterm></entry>
8888
<entry><type>float8</type></entry>
8989
<entry>Converts the great circle distance between two points on the
9090
surface of the Earth to the normal straight line (secant) distance
9191
between them.
9292
</entry>
9393
</row>
9494
<row>
95-
<entry><function>ll_to_earth(float8, float8)</function></entry>
95+
<entry><function>ll_to_earth(float8, float8)</function><indexterm><primary>ll_to_earth</primary></indexterm></entry>
9696
<entry><type>earth</type></entry>
9797
<entry>Returns the location of a point on the surface of the Earth given
9898
its latitude (argument 1) and longitude (argument 2) in degrees.
9999
</entry>
100100
</row>
101101
<row>
102-
<entry><function>latitude(earth)</function></entry>
102+
<entry><function>latitude(earth)</function><indexterm><primary>latitude</primary></indexterm></entry>
103103
<entry><type>float8</type></entry>
104104
<entry>Returns the latitude in degrees of a point on the surface of the
105105
Earth.
106106
</entry>
107107
</row>
108108
<row>
109-
<entry><function>longitude(earth)</function></entry>
109+
<entry><function>longitude(earth)</function><indexterm><primary>longitude</primary></indexterm></entry>
110110
<entry><type>float8</type></entry>
111111
<entry>Returns the longitude in degrees of a point on the surface of the
112112
Earth.
113113
</entry>
114114
</row>
115115
<row>
116-
<entry><function>earth_distance(earth, earth)</function></entry>
116+
<entry><function>earth_distance(earth, earth)</function><indexterm><primary>earth_distance</primary></indexterm></entry>
117117
<entry><type>float8</type></entry>
118118
<entry>Returns the great circle distance between two points on the
119119
surface of the Earth.
120120
</entry>
121121
</row>
122122
<row>
123-
<entry><function>earth_box(earth, float8)</function></entry>
123+
<entry><function>earth_box(earth, float8)</function><indexterm><primary>earth_box</primary></indexterm></entry>
124124
<entry><type>cube</type></entry>
125125
<entry>Returns a box suitable for an indexed search using the cube
126126
<literal>@&gt;</>

‎doc/src/sgml/fuzzystrmatch.sgml

+28
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,14 @@
3535
for working with Soundex codes:
3636
</para>
3737

38+
<indexterm>
39+
<primary>soundex</primary>
40+
</indexterm>
41+
42+
<indexterm>
43+
<primary>difference</primary>
44+
</indexterm>
45+
3846
<synopsis>
3947
soundex(text) returns text
4048
difference(text, text) returns int
@@ -81,6 +89,14 @@ SELECT * FROM s WHERE difference(s.nm, 'john') &gt; 2;
8189
This function calculates the Levenshtein distance between two strings:
8290
</para>
8391

92+
<indexterm>
93+
<primary>levenshtein</primary>
94+
</indexterm>
95+
96+
<indexterm>
97+
<primary>levenshtein_less_equal</primary>
98+
</indexterm>
99+
84100
<synopsis>
85101
levenshtein(text source, text target, int ins_cost, int del_cost, int sub_cost) returns int
86102
levenshtein(text source, text target) returns int
@@ -145,6 +161,10 @@ test=# SELECT levenshtein_less_equal('extensive', 'exhaustive',4);
145161
This function calculates the metaphone code of an input string:
146162
</para>
147163

164+
<indexterm>
165+
<primary>metaphone</primary>
166+
</indexterm>
167+
148168
<synopsis>
149169
metaphone(text source, int max_output_length) returns text
150170
</synopsis>
@@ -180,6 +200,14 @@ test=# SELECT metaphone('GUMBO', 4);
180200
These functions compute the primary and alternate codes:
181201
</para>
182202

203+
<indexterm>
204+
<primary>dmetaphone</primary>
205+
</indexterm>
206+
207+
<indexterm>
208+
<primary>dmetaphone_alt</primary>
209+
</indexterm>
210+
183211
<synopsis>
184212
dmetaphone(text source) returns text
185213
dmetaphone_alt(text source) returns text

0 commit comments

Comments
 (0)