odbc-columnprivileges.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.odbc-columnprivileges" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>odbc_columnprivileges</refname>
  <refpurpose>Lists columns and associated privileges for the given table</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>odbc_columnprivileges</methodname>
   <methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
   <methodparam><type>string</type><parameter>qualifier</parameter></methodparam>
   <methodparam><type>string</type><parameter>owner</parameter></methodparam>
   <methodparam><type>string</type><parameter>table_name</parameter></methodparam>
   <methodparam><type>string</type><parameter>column_name</parameter></methodparam>
  </methodsynopsis>
  <para>
   Lists columns and associated privileges for the given table.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection_id</parameter></term>
     <listitem>
      &odbc.connection.id;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>qualifier</parameter></term>
     <listitem>
      <para>
       The qualifier.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>owner</parameter></term>
     <listitem>
      <para>
       The owner.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table_name</parameter></term>
     <listitem>
      <para>
       The table name.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>column_name</parameter></term>
     <listitem>
      <para>
       The <parameter>column_name</parameter> argument accepts search
       patterns ('%' to match zero or more characters and '_' to match a
       single character).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
  <para>
   The <parameter>owner</parameter>, <parameter>table_name</parameter>, and
   <parameter>column_name</parameter> accept search patterns ('%' to match
   zero or more characters and '_' to match a single character).
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an ODBC result identifier&return.falseforfailure;.
   This result identifier can be used to fetch a list of columns and
   associated privileges.
  </para>
  <para>
   The result set has the following columns:
   <itemizedlist>
    <listitem><simpara>TABLE_QUALIFIER</simpara></listitem>
    <listitem><simpara>TABLE_OWNER</simpara></listitem>
    <listitem><simpara>TABLE_NAME</simpara></listitem>
    <listitem><simpara>GRANTOR</simpara></listitem>
    <listitem><simpara>GRANTEE</simpara></listitem>
    <listitem><simpara>PRIVILEGE</simpara></listitem>
    <listitem><simpara>IS_GRANTABLE</simpara></listitem>
   </itemizedlist>
  </para>
  <para>
   The result set is ordered by TABLE_QUALIFIER, TABLE_OWNER and
   TABLE_NAME.
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->