File: odbc-columnprivileges.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (169 lines) | stat: -rw-r--r-- 4,840 bytes parent folder | download | duplicates (2)
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
<?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 class="union"><type>Odbc\Result</type><type>false</type></type><methodname>odbc_columnprivileges</methodname>
   <methodparam><type>Odbc\Connection</type><parameter>odbc</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>catalog</parameter></methodparam>
   <methodparam><type>string</type><parameter>schema</parameter></methodparam>
   <methodparam><type>string</type><parameter>table</parameter></methodparam>
   <methodparam><type>string</type><parameter>column</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>odbc</parameter></term>
     <listitem>
      &odbc.connection.id;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>catalog</parameter></term>
     <listitem>
      <para>
       &odbc.parameter.catalog;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>schema</parameter></term>
     <listitem>
      <para>
       &odbc.parameter.schema;
       &odbc.parameter.search;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table</parameter></term>
     <listitem>
      <para>
       The table name.
       &odbc.parameter.search;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>column</parameter></term>
     <listitem>
      <para>
       The column name.
       &odbc.parameter.search;
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &odbc.result.object-return-falseforfailure;
   This result object can be used to fetch a list of columns and
   associated privileges.
  </para>
  <para>
   The result set has the following columns:
   <itemizedlist>
    <listitem><simpara><literal>TABLE_CAT</literal></simpara></listitem>
    <listitem><simpara><literal>TABLE_SCHEM</literal></simpara></listitem>
    <listitem><simpara><literal>TABLE_NAME</literal></simpara></listitem>
    <listitem><simpara><literal>COLUMN_NAME</literal></simpara></listitem>
    <listitem><simpara><literal>GRANTOR</literal></simpara></listitem>
    <listitem><simpara><literal>GRANTEE</literal></simpara></listitem>
    <listitem><simpara><literal>PRIVILEGE</literal></simpara></listitem>
    <listitem><simpara><literal>IS_GRANTABLE</literal></simpara></listitem>
   </itemizedlist>
   &odbc.result.driver-specific;
  </para>
  <simpara>
   The result set is ordered by <literal>TABLE_CAT</literal>, <literal>TABLE_SCHEM</literal>,
   <literal>TABLE_NAME</literal>, <literal>COLUMN_NAME</literal> and <literal>PRIVILEGE</literal>.
  </simpara>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &odbc.changelog.connection-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example xml:id="odbc-columnprivileges.example.basic">
   <title>List Privileges for a Column</title>
   <programlisting role="php">
<![CDATA[
<?php
$conn = odbc_connect($dsn, $user, $pass);
$privileges = odbc_columnprivileges($conn, 'TutorialDB', 'dbo', 'test', 'id');
while (($row = odbc_fetch_array($privileges))) {
    print_r($row);
    break; // further rows omitted for brevity
}
?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
Array
(
    [TABLE_CAT] => TutorialDB
    [TABLE_SCHEM] => dbo
    [TABLE_NAME] => test
    [COLUMN_NAME] => id
    [GRANTOR] => dbo
    [GRANTEE] => dbo
    [PRIVILEGE] => INSERT
    [IS_GRANTABLE] => YES
)
]]>
   </screen>
  </example>
 </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
-->