MAINHACK

Viewing / Editing File: ecpg-sql-describe.html

File is not writable. Editing disabled.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>DESCRIBE</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="Embedded SQL Commands"
HREF="ecpg-sql-commands.html"><LINK
REL="PREVIOUS"
TITLE="DECLARE"
HREF="ecpg-sql-declare.html"><LINK
REL="NEXT"
TITLE="DISCONNECT"
HREF="ecpg-sql-disconnect.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="DECLARE"
HREF="ecpg-sql-declare.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="ecpg-sql-commands.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="60%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="20%"
ALIGN="right"
VALIGN="top"
><A
TITLE="DISCONNECT"
HREF="ecpg-sql-disconnect.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="ECPG-SQL-DESCRIBE"
></A
>DESCRIBE</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN45358"
></A
><H2
>Name</H2
>DESCRIBE&nbsp;--&nbsp;obtain information about a prepared statement or result set</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN45361"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>DESCRIBE [ OUTPUT ] <TT
CLASS="REPLACEABLE"
><I
>prepared_name</I
></TT
> USING [ SQL ] DESCRIPTOR <TT
CLASS="REPLACEABLE"
><I
>descriptor_name</I
></TT
>
DESCRIBE [ OUTPUT ] <TT
CLASS="REPLACEABLE"
><I
>prepared_name</I
></TT
> INTO [ SQL ] DESCRIPTOR <TT
CLASS="REPLACEABLE"
><I
>descriptor_name</I
></TT
>
DESCRIBE [ OUTPUT ] <TT
CLASS="REPLACEABLE"
><I
>prepared_name</I
></TT
> INTO <TT
CLASS="REPLACEABLE"
><I
>sqlda_name</I
></TT
></PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN45369"
></A
><H2
>Description</H2
><P
>     <TT
CLASS="COMMAND"
>DESCRIBE</TT
> retrieves metadata information about
     the result columns contained in a prepared statement, without
     actually fetching a row.
    </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN45373"
></A
><H2
>Parameters</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="REPLACEABLE"
><I
>prepared_name</I
></TT
></DT
><DD
><P
>        The name of a prepared statement.  This can be an SQL
        identifier or a host variable.
       </P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>descriptor_name</I
></TT
></DT
><DD
><P
>        A descriptor name. It is case sensitive.  It can be an SQL
        identifier or a host variable.
       </P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>sqlda_name</I
></TT
></DT
><DD
><P
>        The name of an SQLDA variable.
       </P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN45391"
></A
><H2
>Examples</H2
><PRE
CLASS="PROGRAMLISTING"
>EXEC SQL ALLOCATE DESCRIPTOR mydesc;
EXEC SQL PREPARE stmt1 FROM :sql_stmt;
EXEC SQL DESCRIBE stmt1 INTO SQL DESCRIPTOR mydesc;
EXEC SQL GET DESCRIPTOR mydesc VALUE 1 :charvar = NAME;
EXEC SQL DEALLOCATE DESCRIPTOR mydesc;</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN45394"
></A
><H2
>Compatibility</H2
><P
>     <TT
CLASS="COMMAND"
>DESCRIBE</TT
> is specified in the SQL standard.
    </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN45398"
></A
><H2
>See Also</H2
><A
HREF="ecpg-sql-allocate-descriptor.html"
>ALLOCATE DESCRIPTOR</A
>, <A
HREF="ecpg-sql-get-descriptor.html"
>GET DESCRIPTOR</A
></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="ecpg-sql-declare.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="ecpg-sql-disconnect.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>DECLARE</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ecpg-sql-commands.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>DISCONNECT</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Cancel / Back
[ MAINHACK ]

Viewing / Editing File: ecpg-sql-describe.html

Server Info

System Features

User Info
