dblink_cancel_query(3) [centos man page]

DBLINK_CANCEL_QUERY(3)					  PostgreSQL 9.2.7 Documentation				    DBLINK_CANCEL_QUERY(3)

NAME

       dblink_cancel_query - cancels any active query on the named connection

SYNOPSIS

       dblink_cancel_query(text connname) returns text

DESCRIPTION

       dblink_cancel_query attempts to cancel any query that is in progress on the named connection. Note that this is not certain to succeed
       (since, for example, the remote query might already have finished). A cancel request simply improves the odds that the query will fail
       soon. You must still complete the normal query protocol, for example by calling dblink_get_result.

ARGUMENTS

       conname
	   Name of the connection to use.

RETURN VALUE

       Returns OK if the cancel request has been sent, or the text of an error message on failure.

EXAMPLES

	   SELECT dblink_cancel_query('dtest1');

PostgreSQL 9.2.7						    2014-02-17						    DBLINK_CANCEL_QUERY(3)

DBLINK_FETCH(3) 					  PostgreSQL 9.2.7 Documentation					   DBLINK_FETCH(3)

NAME

       dblink_fetch - returns rows from an open cursor in a remote database

SYNOPSIS

       dblink_fetch(text cursorname, int howmany [, bool fail_on_error]) returns setof record
       dblink_fetch(text connname, text cursorname, int howmany [, bool fail_on_error]) returns setof record

DESCRIPTION

       dblink_fetch fetches rows from a cursor previously established by dblink_open.

ARGUMENTS

       conname
	   Name of the connection to use; omit this parameter to use the unnamed connection.

       cursorname
	   The name of the cursor to fetch from.

       howmany
	   The maximum number of rows to retrieve. The next howmany rows are fetched, starting at the current cursor position, moving forward.
	   Once the cursor has reached its end, no more rows are produced.

       fail_on_error
	   If true (the default when omitted) then an error thrown on the remote side of the connection causes an error to also be thrown locally.
	   If false, the remote error is locally reported as a NOTICE, and the function returns no rows.

RETURN VALUE

       The function returns the row(s) fetched from the cursor. To use this function, you will need to specify the expected set of columns, as
       previously discussed for dblink.

NOTES

       On a mismatch between the number of return columns specified in the FROM clause, and the actual number of columns returned by the remote
       cursor, an error will be thrown. In this event, the remote cursor is still advanced by as many rows as it would have been if the error had
       not occurred. The same is true for any other error occurring in the local query after the remote FETCH has been done.

EXAMPLES

	   SELECT dblink_connect('dbname=postgres');
	    dblink_connect
	   ----------------
	    OK
	   (1 row)

	   SELECT dblink_open('foo', 'select proname, prosrc from pg_proc where proname like ''bytea%''');
	    dblink_open
	   -------------
	    OK
	   (1 row)

	   SELECT * FROM dblink_fetch('foo', 5) AS (funcname name, source text);
	    funcname |	source
	   ----------+----------
	    byteacat | byteacat
	    byteacmp | byteacmp
	    byteaeq  | byteaeq
	    byteage  | byteage
	    byteagt  | byteagt
	   (5 rows)

	   SELECT * FROM dblink_fetch('foo', 5) AS (funcname name, source text);
	    funcname  |  source
	   -----------+-----------
	    byteain   | byteain
	    byteale   | byteale
	    bytealike | bytealike
	    bytealt   | bytealt
	    byteane   | byteane
	   (5 rows)

	   SELECT * FROM dblink_fetch('foo', 5) AS (funcname name, source text);
	     funcname  |   source
	   ------------+------------
	    byteanlike | byteanlike
	    byteaout   | byteaout
	   (2 rows)

	   SELECT * FROM dblink_fetch('foo', 5) AS (funcname name, source text);
	    funcname | source
	   ----------+--------
	   (0 rows)

PostgreSQL 9.2.7						    2014-02-17							   DBLINK_FETCH(3)