File: function.odbc-tables.html

package info (click to toggle)
php3 3%3A3.0.18-0potato1.1
links: PTS
area: main
in suites: potato
size: 17,736 kB
ctags: 11,198
sloc: ansic: 108,120; sh: 2,512; php: 2,024; yacc: 1,887; makefile: 1,038; perl: 537; pascal: 238; awk: 90; cpp: 28; sql: 11
file content (366 lines) | stat: -rw-r--r-- 5,305 bytes
parent folder | download | duplicates (3)
<HTML
><HEAD
><TITLE
>odbc_tables</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="manual.html"><LINK
REL="UP"
TITLE="Unified ODBC functions"
HREF="ref.odbc.html"><LINK
REL="PREVIOUS"
TITLE="odbc_setoption"
HREF="function.odbc-setoption.html"><LINK
REL="NEXT"
TITLE="odbc_tableprivileges"
HREF="function.odbc-tableprivileges.html"><META
NAME="HTTP_EQUIV"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.odbc-setoption.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.odbc-tableprivileges.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.odbc-tables"
>odbc_tables</A
></H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN26159"
></A
><P
>    (PHP4 &#62;= 4.0b4)</P
>odbc_tables&nbsp;--&nbsp;
     Get the list of table names stored in a specific data source.
     Returns a result identifier containing the
     information.
    </DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN26162"
></A
><H2
>Description</H2
><DIV
CLASS="funcsynopsis"
><A
NAME="AEN26164"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <B
CLASS="function"
>odbc_tables</B
></CODE
> (int connection_id [, string qualifier [, string owner [, string name [, string types]]]])</CODE
></P
><P
></P
></DIV
><P
>&#13;     Lists all tables in the requested range.  Returns an ODBC result
     identifier or <TT
CLASS="literal"
>false</TT
> on failure.
    </P
><P
>&#13;     The result set has the following columns:
     <P
></P
><UL
><LI
><P
>TABLE_QUALIFIER</P
></LI
><LI
><P
>TABLE_OWNER</P
></LI
><LI
><P
>TABLE_NAME</P
></LI
><LI
><P
>TABLE_TYPE</P
></LI
><LI
><P
>REMARKS</P
></LI
></UL
> 
    </P
><P
>&#13;     The result set is ordered by TABLE_TYPE, TABLE_QUALIFIER,
     TABLE_OWNER and TABLE_NAME.
    </P
><P
>&#13;     The <TT
CLASS="parameter"
><I
>owner</I
></TT
> and <TT
CLASS="parameter"
><I
>name</I
></TT
>
     arguments accept search patterns ('%' to match zero or more
     characters and '_' to match a single character).
    </P
><P
>&#13;     To support enumeration of qualifiers, owners, and table types,
     the following special semantics for the
     <TT
CLASS="parameter"
><I
>qualifier</I
></TT
>, <TT
CLASS="parameter"
><I
>owner</I
></TT
>,
     <TT
CLASS="parameter"
><I
>name</I
></TT
>, and
     <TT
CLASS="parameter"
><I
>table_type</I
></TT
> are available:
     <P
></P
><UL
><LI
><P
>&#13;	If <TT
CLASS="parameter"
><I
>qualifier</I
></TT
> is a single percent
	character (%) and <TT
CLASS="parameter"
><I
>owner</I
></TT
> and
	<TT
CLASS="parameter"
><I
>name</I
></TT
> are empty strings, then the result
	set contains a list of valid qualifiers for the data
	source. (All columns except the TABLE_QUALIFIER column contain
	NULLs.)
       </P
></LI
><LI
><P
>&#13;	If <TT
CLASS="parameter"
><I
>owner</I
></TT
> is a single percent character
	(%) and <TT
CLASS="parameter"
><I
>qualifier</I
></TT
> and
	<TT
CLASS="parameter"
><I
>name</I
></TT
> are empty strings, then the result
	set contains a list of valid owners for the data source. (All
	columns except the TABLE_OWNER column contain
	NULLs.)
       </P
></LI
><LI
><P
>&#13;	If <TT
CLASS="parameter"
><I
>table_type</I
></TT
> is a single percent
	character (%) and <TT
CLASS="parameter"
><I
>qualifier</I
></TT
>,
	<TT
CLASS="parameter"
><I
>owner</I
></TT
> and <TT
CLASS="parameter"
><I
>name</I
></TT
>
	are empty strings, then the result set contains a list of
	valid table types for the data source. (All columns except the
	TABLE_TYPE column contain NULLs.)
       </P
></LI
></UL
> 
    </P
><P
>&#13;     If <TT
CLASS="parameter"
><I
>table_type</I
></TT
> is not an empty string, it
     must contain a list of comma-separated values for the types of
     interest; each value may be enclosed in single quotes (') or
     unquoted. For example, "'TABLE','VIEW'" or "TABLE, VIEW".  If the
     data source does not support a specified table type,
     <B
CLASS="function"
>odbc_tables()</B
> does not return any results for
     that type.
    </P
><P
>&#13;     See also <A
HREF="function.odbc-tableprivileges.html"
><B
CLASS="function"
>odbc_tableprivileges()</B
></A
> to retrieve
     associated privileges.
    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.odbc-setoption.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manual.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.odbc-tableprivileges.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>odbc_setoption</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.odbc.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>odbc_tableprivileges</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>