reference/uodbc/functions/odbc-columnprivileges.xml
902c2b77f827e8d0ecccf4f62fb90065d2f6ef79
...
...
@@ -8,12 +8,12 @@
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
-
<type>resource</type><methodname>odbc_columnprivileges</methodname>
12
-
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
13
-
<methodparam><type>string</type><parameter>qualifier</parameter></methodparam>
14
-
<methodparam><type>string</type><parameter>owner</parameter></methodparam>
15
-
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
16
-
<methodparam><type>string</type><parameter>column_name</parameter></methodparam>
11
+
<type class="union"><type>resource</type><type>false</type></type><methodname>odbc_columnprivileges</methodname>
12
+
<methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
13
+
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>catalog</parameter></methodparam>
14
+
<methodparam><type>string</type><parameter>schema</parameter></methodparam>
15
+
<methodparam><type>string</type><parameter>table</parameter></methodparam>
16
+
<methodparam><type>string</type><parameter>column</parameter></methodparam>
17
17
</methodsynopsis>
18
18
<para>
19
19
Lists columns and associated privileges for the given table.
...
...
@@ -24,52 +24,48 @@
24
24
<para>
25
25
<variablelist>
26
26
<varlistentry>
27
-
<term><parameter>connection_id</parameter></term>
27
+
<term><parameter>odbc</parameter></term>
28
28
<listitem>
29
29
&odbc.connection.id;
30
30
</listitem>
31
31
</varlistentry>
32
32
<varlistentry>
33
-
<term><parameter>qualifier</parameter></term>
33
+
<term><parameter>catalog</parameter></term>
34
34
<listitem>
35
35
<para>
36
-
The qualifier.
36
+
&odbc.parameter.catalog;
37
37
</para>
38
38
</listitem>
39
39
</varlistentry>
40
40
<varlistentry>
41
-
<term><parameter>owner</parameter></term>
41
+
<term><parameter>schema</parameter></term>
42
42
<listitem>
43
43
<para>
44
-
The owner.
44
+
&odbc.parameter.schema;
45
+
&odbc.parameter.search;
45
46
</para>
46
47
</listitem>
47
48
</varlistentry>
48
49
<varlistentry>
49
-
<term><parameter>table_name</parameter></term>
50
+
<term><parameter>table</parameter></term>
50
51
<listitem>
51
52
<para>
52
53
The table name.
54
+
&odbc.parameter.search;
53
55
</para>
54
56
</listitem>
55
57
</varlistentry>
56
58
<varlistentry>
57
-
<term><parameter>column_name</parameter></term>
59
+
<term><parameter>column</parameter></term>
58
60
<listitem>
59
61
<para>
60
-
The <parameter>column_name</parameter> argument accepts search
61
-
patterns ('%' to match zero or more characters and '_' to match a
62
-
single character).
62
+
The column name.
63
+
&odbc.parameter.search;
63
64
</para>
64
65
</listitem>
65
66
</varlistentry>
66
67
</variablelist>
67
68
</para>
68
-
<para>
69
-
The <parameter>owner</parameter>, <parameter>table_name</parameter>, and
70
-
<parameter>column_name</parameter> accept search patterns ('%' to match
71
-
zero or more characters and '_' to match a single character).
72
-
</para>
73
69
</refsect1>
74
70
<refsect1 role="returnvalues">
75
71
&reftitle.returnvalues;
...
...
@@ -81,22 +77,59 @@
81
77
<para>
82
78
The result set has the following columns:
83
79
<itemizedlist>
84
-
<listitem><simpara>TABLE_QUALIFIER</simpara></listitem>
85
-
<listitem><simpara>TABLE_OWNER</simpara></listitem>
86
-
<listitem><simpara>TABLE_NAME</simpara></listitem>
87
-
<listitem><simpara>GRANTOR</simpara></listitem>
88
-
<listitem><simpara>GRANTEE</simpara></listitem>
89
-
<listitem><simpara>PRIVILEGE</simpara></listitem>
90
-
<listitem><simpara>IS_GRANTABLE</simpara></listitem>
80
+
<listitem><simpara><literal>TABLE_CAT</literal></simpara></listitem>
81
+
<listitem><simpara><literal>TABLE_SCHEM</literal></simpara></listitem>
82
+
<listitem><simpara><literal>TABLE_NAME</literal></simpara></listitem>
83
+
<listitem><simpara><literal>COLUMN_NAME</literal></simpara></listitem>
84
+
<listitem><simpara><literal>GRANTOR</literal></simpara></listitem>
85
+
<listitem><simpara><literal>GRANTEE</literal></simpara></listitem>
86
+
<listitem><simpara><literal>PRIVILEGE</literal></simpara></listitem>
87
+
<listitem><simpara><literal>IS_GRANTABLE</literal></simpara></listitem>
91
88
</itemizedlist>
89
+
&odbc.result.driver-specific;
92
90
</para>
93
-
<para>
94
-
The result set is ordered by TABLE_QUALIFIER, TABLE_OWNER and
95
-
TABLE_NAME.
96
-
</para>
91
+
<simpara>
92
+
The result set is ordered by <literal>TABLE_CAT</literal>, <literal>TABLE_SCHEM</literal>,
93
+
<literal>TABLE_NAME</literal>, <literal>COLUMN_NAME</literal> and <literal>PRIVILEGE</literal>.
94
+
</simpara>
95
+
</refsect1>
96
+

97
+
<refsect1 role="examples">
98
+
&reftitle.examples;
99
+
<example xml:id="odbc-columnprivileges.example.basic">
100
+
<title>List Privileges for a Column</title>
101
+
<programlisting role="php">
102
+
<![CDATA[
103
+
<?php
104
+
$conn = odbc_connect($dsn, $user, $pass);
105
+
$privileges = odbc_columnprivileges($conn, 'TutorialDB', 'dbo', 'test', 'id');
106
+
while (($row = odbc_fetch_array($privileges))) {
107
+
print_r($row);
108
+
break; // further rows omitted for brevity
109
+
}
110
+
?>
111
+
]]>
112
+
</programlisting>
113
+
&example.outputs.similar;
114
+
<screen>
115
+
<![CDATA[
116
+
Array
117
+
(
118
+
[TABLE_CAT] => TutorialDB
119
+
[TABLE_SCHEM] => dbo
120
+
[TABLE_NAME] => test
121
+
[COLUMN_NAME] => id
122
+
[GRANTOR] => dbo
123
+
[GRANTEE] => dbo
124
+
[PRIVILEGE] => INSERT
125
+
[IS_GRANTABLE] => YES
126
+
)
127
+
]]>
128
+
</screen>
129
+
</example>
97
130
</refsect1>
98
-
</refentry>
99
131

132
+
</refentry>
100
133
<!-- Keep this comment at the end of the file
101
134
Local variables:
102
135
mode: sgml
103
136