1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.db2-column-privileges">
<refnamediv>
<refname>db2_column_privileges</refname>
<refpurpose>
Returns a result set listing the columns and associated privileges for a table
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>db2_column_privileges</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>qualifier</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>schema</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>table-name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>column-name</parameter></methodparam>
</methodsynopsis>
<para>
Returns a result set listing the columns and associated privileges for a
table.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A valid connection to an IBM DB2, Cloudscape, or Apache Derby database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>qualifier</parameter></term>
<listitem>
<para>
A qualifier for DB2 databases running on OS/390 or z/OS servers. For
other databases, pass &null; or an empty string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>schema</parameter></term>
<listitem>
<para>
The schema which contains the tables. To match all schemas, pass &null;
or an empty string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>table-name</parameter></term>
<listitem>
<para>
The name of the table or view. To match all tables in the database,
pass &null; or an empty string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>column-name</parameter></term>
<listitem>
<para>
The name of the column. To match all columns in the table, pass &null;
or an empty string.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a statement resource with a result set containing rows describing
the column privileges for columns matching the specified parameters. The
rows are composed of the following columns:
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Column name</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>TABLE_CAT</entry>
<entry>Name of the catalog. The value is NULL if this table does not
have catalogs.</entry>
</row>
<row>
<entry>TABLE_SCHEM</entry>
<entry>Name of the schema.</entry>
</row>
<row>
<entry>TABLE_NAME</entry>
<entry>Name of the table or view.</entry>
</row>
<row>
<entry>COLUMN_NAME</entry>
<entry>Name of the column.</entry>
</row>
<row>
<entry>GRANTOR</entry>
<entry>Authorization ID of the user who granted the privilege.</entry>
</row>
<row>
<entry>GRANTEE</entry>
<entry>Authorization ID of the user to whom the privilege was
granted.</entry>
</row>
<row>
<entry>PRIVILEGE</entry>
<entry>The privilege for the column.</entry>
</row>
<row>
<entry>IS_GRANTABLE</entry>
<entry>Whether the GRANTEE is permitted to grant this privilege to
other users.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>db2_column_privileges</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>db2_columns</function></member>
<member><function>db2_foreign_keys</function></member>
<member><function>db2_primary_keys</function></member>
<member><function>db2_procedure_columns</function></member>
<member><function>db2_procedures</function></member>
<member><function>db2_special_columns</function></member>
<member><function>db2_statistics</function></member>
<member><function>db2_table_privileges</function></member>
<member><function>db2_tables</function></member>
</simplelist>
</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:"../../../../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
-->
|