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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.db2-foreign-keys">
<refnamediv>
<refname>db2_foreign_keys</refname>
<refpurpose>
Returns a result set listing the foreign keys for a table
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>db2_foreign_keys</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>qualifier</parameter></methodparam>
<methodparam><type>string</type><parameter>schema</parameter></methodparam>
<methodparam><type>string</type><parameter>table-name</parameter></methodparam>
</methodsynopsis>
<para>
Returns a result set listing the foreign keys 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. If <parameter>schema</parameter>
is &null;, <function>db2_foreign_keys</function> matches the schema for
the current connection.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>table-name</parameter></term>
<listitem>
<para>
The name of the table.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a statement resource with a result set containing rows describing
the foreign keys for the specified table. The result set is composed of the
following columns:
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Column name</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>PKTABLE_CAT</entry>
<entry>
Name of the catalog for the table containing the primary key. The
value is NULL if this table does not have catalogs.
</entry>
</row>
<row>
<entry>PKTABLE_SCHEM</entry>
<entry>
Name of the schema for the table containing the primary key.
</entry>
</row>
<row>
<entry>PKTABLE_NAME</entry>
<entry>Name of the table containing the primary key.</entry>
</row>
<row>
<entry>PKCOLUMN_NAME</entry>
<entry>Name of the column containing the primary key.</entry>
</row>
<row>
<entry>FKTABLE_CAT</entry>
<entry>
Name of the catalog for the table containing the foreign key. The
value is NULL if this table does not have catalogs.
</entry>
</row>
<row>
<entry>FKTABLE_SCHEM</entry>
<entry>
Name of the schema for the table containing the foreign key.
</entry>
</row>
<row>
<entry>FKTABLE_NAME</entry>
<entry>Name of the table containing the foreign key.</entry>
</row>
<row>
<entry>FKCOLUMN_NAME</entry>
<entry>Name of the column containing the foreign key.</entry>
</row>
<row>
<entry>KEY_SEQ</entry>
<entry>1-indexed position of the column in the key.</entry>
</row>
<row>
<entry>UPDATE_RULE</entry>
<entry>
Integer value representing the action applied to the foreign key
when the SQL operation is UPDATE.
</entry>
</row>
<row>
<entry>DELETE_RULE</entry>
<entry>
Integer value representing the action applied to the foreign key
when the SQL operation is DELETE.
</entry>
</row>
<row>
<entry>FK_NAME</entry>
<entry>The name of the foreign key.</entry>
</row>
<row>
<entry>PK_NAME</entry>
<entry>The name of the primary key.</entry>
</row>
<row>
<entry>DEFERRABILITY</entry>
<entry>
An integer value representing whether the foreign key deferrability is
SQL_INITIALLY_DEFERRED, SQL_INITIALLY_IMMEDIATE, or
SQL_NOT_DEFERRABLE.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>db2_foreign_keys</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_column_privileges</function></member>
<member><function>db2_columns</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
-->
|
