aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/dblink.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/sgml/dblink.sgml')
-rw-r--r--doc/src/sgml/dblink.sgml152
1 files changed, 76 insertions, 76 deletions
diff --git a/doc/src/sgml/dblink.sgml b/doc/src/sgml/dblink.sgml
index a26e3786782..b07ac48c005 100644
--- a/doc/src/sgml/dblink.sgml
+++ b/doc/src/sgml/dblink.sgml
@@ -19,6 +19,10 @@
</para>
<refentry id="CONTRIB-DBLINK-CONNECT">
+ <indexterm>
+ <primary>dblink_connect</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink_connect</refentrytitle>
<manvolnum>3</manvolnum>
@@ -29,10 +33,6 @@
<refpurpose>opens a persistent connection to a remote database</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink_connect</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink_connect(text connstr) returns text
@@ -183,6 +183,10 @@ DROP SERVER fdtest;
</refentry>
<refentry id="CONTRIB-DBLINK-CONNECT-U">
+ <indexterm>
+ <primary>dblink_connect_u</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink_connect_u</refentrytitle>
<manvolnum>3</manvolnum>
@@ -193,10 +197,6 @@ DROP SERVER fdtest;
<refpurpose>opens a persistent connection to a remote database, insecurely</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink_connect_u</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink_connect_u(text connstr) returns text
@@ -240,6 +240,10 @@ dblink_connect_u(text connname, text connstr) returns text
</refentry>
<refentry id="CONTRIB-DBLINK-DISCONNECT">
+ <indexterm>
+ <primary>dblink_disconnect</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink_disconnect</refentrytitle>
<manvolnum>3</manvolnum>
@@ -250,10 +254,6 @@ dblink_connect_u(text connname, text connstr) returns text
<refpurpose>closes a persistent connection to a remote database</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink_disconnect</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink_disconnect() returns text
@@ -315,6 +315,10 @@ SELECT dblink_disconnect('myconn');
</refentry>
<refentry id="CONTRIB-DBLINK-FUNCTION">
+ <indexterm>
+ <primary>dblink</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink</refentrytitle>
<manvolnum>3</manvolnum>
@@ -325,10 +329,6 @@ SELECT dblink_disconnect('myconn');
<refpurpose>executes a query in a remote database</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink(text connname, text sql [, bool fail_on_error]) returns setof record
@@ -533,6 +533,10 @@ SELECT * FROM dblink('myconn', 'select proname, prosrc from pg_proc')
</refentry>
<refentry id="CONTRIB-DBLINK-EXEC">
+ <indexterm>
+ <primary>dblink_exec</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink_exec</refentrytitle>
<manvolnum>3</manvolnum>
@@ -543,10 +547,6 @@ SELECT * FROM dblink('myconn', 'select proname, prosrc from pg_proc')
<refpurpose>executes a command in a remote database</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink_exec</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink_exec(text connname, text sql [, bool fail_on_error]) returns text
@@ -670,6 +670,10 @@ DETAIL: ERROR: null value in column "relnamespace" violates not-null constrain
</refentry>
<refentry id="CONTRIB-DBLINK-OPEN">
+ <indexterm>
+ <primary>dblink_open</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink_open</refentrytitle>
<manvolnum>3</manvolnum>
@@ -680,10 +684,6 @@ DETAIL: ERROR: null value in column "relnamespace" violates not-null constrain
<refpurpose>opens a cursor in a remote database</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink_open</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink_open(text cursorname, text sql [, bool fail_on_error]) returns text
@@ -794,6 +794,10 @@ SELECT dblink_open('foo', 'select proname, prosrc from pg_proc');
</refentry>
<refentry id="CONTRIB-DBLINK-FETCH">
+ <indexterm>
+ <primary>dblink_fetch</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink_fetch</refentrytitle>
<manvolnum>3</manvolnum>
@@ -804,10 +808,6 @@ SELECT dblink_open('foo', 'select proname, prosrc from pg_proc');
<refpurpose>returns rows from an open cursor in a remote database</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink_fetch</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink_fetch(text cursorname, int howmany [, bool fail_on_error]) returns setof record
@@ -947,6 +947,10 @@ SELECT * FROM dblink_fetch('foo', 5) AS (funcname name, source text);
</refentry>
<refentry id="CONTRIB-DBLINK-CLOSE">
+ <indexterm>
+ <primary>dblink_close</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink_close</refentrytitle>
<manvolnum>3</manvolnum>
@@ -957,10 +961,6 @@ SELECT * FROM dblink_fetch('foo', 5) AS (funcname name, source text);
<refpurpose>closes a cursor in a remote database</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink_close</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink_close(text cursorname [, bool fail_on_error]) returns text
@@ -1058,6 +1058,10 @@ SELECT dblink_close('foo');
</refentry>
<refentry id="CONTRIB-DBLINK-GET-CONNECTIONS">
+ <indexterm>
+ <primary>dblink_get_connections</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink_get_connections</refentrytitle>
<manvolnum>3</manvolnum>
@@ -1068,10 +1072,6 @@ SELECT dblink_close('foo');
<refpurpose>returns the names of all open named dblink connections</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink_get_connections</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink_get_connections() returns text[]
@@ -1103,6 +1103,10 @@ SELECT dblink_get_connections();
</refentry>
<refentry id="CONTRIB-DBLINK-ERROR-MESSAGE">
+ <indexterm>
+ <primary>dblink_error_message</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink_error_message</refentrytitle>
<manvolnum>3</manvolnum>
@@ -1113,10 +1117,6 @@ SELECT dblink_get_connections();
<refpurpose>gets last error message on the named connection</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink_error_message</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink_error_message(text connname) returns text
@@ -1166,6 +1166,10 @@ SELECT dblink_error_message('dtest1');
</refentry>
<refentry id="CONTRIB-DBLINK-SEND-QUERY">
+ <indexterm>
+ <primary>dblink_send_query</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink_send_query</refentrytitle>
<manvolnum>3</manvolnum>
@@ -1176,10 +1180,6 @@ SELECT dblink_error_message('dtest1');
<refpurpose>sends an async query to a remote database</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink_send_query</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink_send_query(text connname, text sql) returns int
@@ -1248,6 +1248,10 @@ SELECT dblink_send_query('dtest1', 'SELECT * FROM foo WHERE f1 &lt; 3');
</refentry>
<refentry id="CONTRIB-DBLINK-IS-BUSY">
+ <indexterm>
+ <primary>dblink_is_busy</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink_is_busy</refentrytitle>
<manvolnum>3</manvolnum>
@@ -1258,10 +1262,6 @@ SELECT dblink_send_query('dtest1', 'SELECT * FROM foo WHERE f1 &lt; 3');
<refpurpose>checks if connection is busy with an async query</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink_is_busy</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink_is_busy(text connname) returns int
@@ -1311,6 +1311,10 @@ SELECT dblink_is_busy('dtest1');
</refentry>
<refentry id="CONTRIB-DBLINK-GET-NOTIFY">
+ <indexterm>
+ <primary>dblink_get_notify</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink_get_notify</refentrytitle>
<manvolnum>3</manvolnum>
@@ -1321,10 +1325,6 @@ SELECT dblink_is_busy('dtest1');
<refpurpose>retrieve async notifications on a connection</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink_get_notify</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink_get_notify() returns setof (notify_name text, be_pid int, extra text)
@@ -1393,6 +1393,10 @@ SELECT * FROM dblink_get_notify();
</refentry>
<refentry id="CONTRIB-DBLINK-GET-RESULT">
+ <indexterm>
+ <primary>dblink_get_result</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink_get_result</refentrytitle>
<manvolnum>3</manvolnum>
@@ -1403,10 +1407,6 @@ SELECT * FROM dblink_get_notify();
<refpurpose>gets an async query result</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink_get_result</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink_get_result(text connname [, bool fail_on_error]) returns setof record
@@ -1557,6 +1557,10 @@ contrib_regression=# SELECT * FROM dblink_get_result('dtest1') AS t1(f1 int, f2
</refentry>
<refentry id="CONTRIB-DBLINK-CANCEL-QUERY">
+ <indexterm>
+ <primary>dblink_cancel_query</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink_cancel_query</refentrytitle>
<manvolnum>3</manvolnum>
@@ -1567,10 +1571,6 @@ contrib_regression=# SELECT * FROM dblink_get_result('dtest1') AS t1(f1 int, f2
<refpurpose>cancels any active query on the named connection</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink_cancel_query</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink_cancel_query(text connname) returns text
@@ -1625,6 +1625,10 @@ SELECT dblink_cancel_query('dtest1');
</refentry>
<refentry id="CONTRIB-DBLINK-GET-PKEY">
+ <indexterm>
+ <primary>dblink_get_pkey</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink_get_pkey</refentrytitle>
<manvolnum>3</manvolnum>
@@ -1637,10 +1641,6 @@ SELECT dblink_cancel_query('dtest1');
</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink_get_pkey</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink_get_pkey(text relname) returns setof dblink_pkey_results
@@ -1717,6 +1717,10 @@ SELECT * FROM dblink_get_pkey('foobar');
</refentry>
<refentry id="CONTRIB-DBLINK-BUILD-SQL-INSERT">
+ <indexterm>
+ <primary>dblink_build_sql_insert</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink_build_sql_insert</refentrytitle>
<manvolnum>3</manvolnum>
@@ -1730,10 +1734,6 @@ SELECT * FROM dblink_get_pkey('foobar');
</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink_build_sql_insert</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink_build_sql_insert(text relname,
@@ -1852,6 +1852,10 @@ SELECT dblink_build_sql_insert('foo', '1 2', 2, '{"1", "a"}', '{"1", "b''a"}');
</refentry>
<refentry id="CONTRIB-DBLINK-BUILD-SQL-DELETE">
+ <indexterm>
+ <primary>dblink_build_sql_delete</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink_build_sql_delete</refentrytitle>
<manvolnum>3</manvolnum>
@@ -1864,10 +1868,6 @@ SELECT dblink_build_sql_insert('foo', '1 2', 2, '{"1", "a"}', '{"1", "b''a"}');
</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink_build_sql_delete</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink_build_sql_delete(text relname,
@@ -1970,6 +1970,10 @@ SELECT dblink_build_sql_delete('"MyFoo"', '1 2', 2, '{"1", "b"}');
</refentry>
<refentry id="CONTRIB-DBLINK-BUILD-SQL-UPDATE">
+ <indexterm>
+ <primary>dblink_build_sql_update</primary>
+ </indexterm>
+
<refmeta>
<refentrytitle>dblink_build_sql_update</refentrytitle>
<manvolnum>3</manvolnum>
@@ -1982,10 +1986,6 @@ SELECT dblink_build_sql_delete('"MyFoo"', '1 2', 2, '{"1", "b"}');
</refpurpose>
</refnamediv>
- <indexterm>
- <primary>dblink_build_sql_update</primary>
- </indexterm>
-
<refsynopsisdiv>
<synopsis>
dblink_build_sql_update(text relname,
generated by cgit v1.2.3 (git 2.25.1) at 2025-08-02 21:06:02 +0000