| Current File : //usr/share/doc/postgresql-9.2.24/html/contrib-dblink-exec.html |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>dblink_exec</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REV="MADE"
HREF="mailto:pgsql-docs@postgresql.org"><LINK
REL="HOME"
TITLE="PostgreSQL 9.2.24 Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="dblink"
HREF="dblink.html"><LINK
REL="PREVIOUS"
TITLE="dblink"
HREF="contrib-dblink-function.html"><LINK
REL="NEXT"
TITLE="dblink_open"
HREF="contrib-dblink-open.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"><META
HTTP-EQUIV="Content-Type"
CONTENT="text/html; charset=ISO-8859-1"><META
NAME="creation"
CONTENT="2017-11-06T22:43:11"></HEAD
><BODY
CLASS="REFENTRY"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="5"
ALIGN="center"
VALIGN="bottom"
><A
HREF="index.html"
>PostgreSQL 9.2.24 Documentation</A
></TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
TITLE="dblink"
HREF="contrib-dblink-function.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="dblink.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="60%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="20%"
ALIGN="right"
VALIGN="top"
><A
TITLE="dblink_open"
HREF="contrib-dblink-open.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="CONTRIB-DBLINK-EXEC"
></A
>dblink_exec</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN147314"
></A
><H2
>Name</H2
>dblink_exec -- executes a command in a remote database</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN147317"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>dblink_exec(text connname, text sql [, bool fail_on_error]) returns text
dblink_exec(text connstr, text sql [, bool fail_on_error]) returns text
dblink_exec(text sql [, bool fail_on_error]) returns text</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN147319"
></A
><H2
>Description</H2
><P
> <CODE
CLASS="FUNCTION"
>dblink_exec</CODE
> executes a command (that is, any SQL statement
that doesn't return rows) in a remote database.
</P
><P
> When two <TT
CLASS="TYPE"
>text</TT
> arguments are given, the first one is first
looked up as a persistent connection's name; if found, the command
is executed on that connection. If not found, the first argument
is treated as a connection info string as for <CODE
CLASS="FUNCTION"
>dblink_connect</CODE
>,
and the indicated connection is made just for the duration of this command.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN147326"
></A
><H2
>Arguments</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="PARAMETER"
>connname</TT
></DT
><DD
><P
> Name of the connection to use; omit this parameter to use the
unnamed connection.
</P
></DD
><DT
><TT
CLASS="PARAMETER"
>connstr</TT
></DT
><DD
><P
> A connection info string, as previously described for
<CODE
CLASS="FUNCTION"
>dblink_connect</CODE
>.
</P
></DD
><DT
><TT
CLASS="PARAMETER"
>sql</TT
></DT
><DD
><P
> The SQL command that you wish to execute in the remote database,
for example
<TT
CLASS="LITERAL"
>insert into foo values(0,'a','{"a0","b0","c0"}')</TT
>.
</P
></DD
><DT
><TT
CLASS="PARAMETER"
>fail_on_error</TT
></DT
><DD
><P
> 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's return value is set to <TT
CLASS="LITERAL"
>ERROR</TT
>.
</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN147352"
></A
><H2
>Return Value</H2
><P
> Returns status, either the command's status string or <TT
CLASS="LITERAL"
>ERROR</TT
>.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN147356"
></A
><H2
>Examples</H2
><PRE
CLASS="SCREEN"
>SELECT dblink_connect('dbname=dblink_test_standby');
dblink_connect
----------------
OK
(1 row)
SELECT dblink_exec('insert into foo values(21,''z'',''{"a0","b0","c0"}'');');
dblink_exec
-----------------
INSERT 943366 1
(1 row)
SELECT dblink_connect('myconn', 'dbname=regression');
dblink_connect
----------------
OK
(1 row)
SELECT dblink_exec('myconn', 'insert into foo values(21,''z'',''{"a0","b0","c0"}'');');
dblink_exec
------------------
INSERT 6432584 1
(1 row)
SELECT dblink_exec('myconn', 'insert into pg_class values (''foo'')',false);
NOTICE: sql error
DETAIL: ERROR: null value in column "relnamespace" violates not-null constraint
dblink_exec
-------------
ERROR
(1 row)</PRE
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="contrib-dblink-function.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="contrib-dblink-open.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>dblink</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="dblink.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>dblink_open</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>