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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.odbc-foreignkeys" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_foreignkeys</refname>
<refpurpose>Retrieves a list of foreign keys</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>Odbc\Result</type><type>false</type></type><methodname>odbc_foreignkeys</methodname>
<methodparam><type>Odbc\Connection</type><parameter>odbc</parameter></methodparam>
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>pk_catalog</parameter></methodparam>
<methodparam><type>string</type><parameter>pk_schema</parameter></methodparam>
<methodparam><type>string</type><parameter>pk_table</parameter></methodparam>
<methodparam><type>string</type><parameter>fk_catalog</parameter></methodparam>
<methodparam><type>string</type><parameter>fk_schema</parameter></methodparam>
<methodparam><type>string</type><parameter>fk_table</parameter></methodparam>
</methodsynopsis>
<para>
Retrieves a list of foreign keys in the specified table or a list of
foreign keys in other tables that refer to the primary key in the
specified 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>pk_catalog</parameter></term>
<listitem>
<para>
The catalog ('qualifier' in ODBC 2 parlance) of the primary key table.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pk_schema</parameter></term>
<listitem>
<para>
The schema ('owner' in ODBC 2 parlance) of the primary key table.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pk_table</parameter></term>
<listitem>
<para>
The primary key table.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fk_catalog</parameter></term>
<listitem>
<para>
The catalog ('qualifier' in ODBC 2 parlance) of the foreign key table.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fk_schema</parameter></term>
<listitem>
<para>
The schema ('owner' in ODBC 2 parlance) of the foreign key table.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fk_table</parameter></term>
<listitem>
<para>
The foreign key table.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&odbc.result.object-return-falseforfailure;
</para>
<para>
The result set has the following columns:
<itemizedlist>
<listitem><simpara><literal>PKTABLE_CAT</literal></simpara></listitem>
<listitem><simpara><literal>PKTABLE_SCHEM</literal></simpara></listitem>
<listitem><simpara><literal>PKTABLE_NAME</literal></simpara></listitem>
<listitem><simpara><literal>PKCOLUMN_NAME</literal></simpara></listitem>
<listitem><simpara><literal>FKTABLE_CAT</literal></simpara></listitem>
<listitem><simpara><literal>FKTABLE_SCHEM</literal></simpara></listitem>
<listitem><simpara><literal>FKTABLE_NAME</literal></simpara></listitem>
<listitem><simpara><literal>FKCOLUMN_NAME</literal></simpara></listitem>
<listitem><simpara><literal>KEY_SEQ</literal></simpara></listitem>
<listitem><simpara><literal>UPDATE_RULE</literal></simpara></listitem>
<listitem><simpara><literal>DELETE_RULE</literal></simpara></listitem>
<listitem><simpara><literal>FK_NAME</literal></simpara></listitem>
<listitem><simpara><literal>PK_NAME</literal></simpara></listitem>
<listitem><simpara><literal>DEFERRABILITY</literal></simpara></listitem>
</itemizedlist>
&odbc.result.driver-specific;
</para>
<simpara>
If the foreign keys associated with a primary key are requested, the result set
is ordered by <literal>FKTABLE_CAT</literal>, <literal>FKTABLE_SCHEM</literal>,
<literal>FKTABLE_NAME</literal> and <literal>KEY_SEQ</literal>.
If the primary keys associated with a foreign key are requested, the result set
is ordered by <literal>PKTABLE_CAT</literal>, <literal>PKTABLE_SCHEM</literal>,
<literal>PKTABLE_NAME</literal> and <literal>KEY_SEQ</literal>.
</simpara>
<simpara>
If <parameter>pk_table</parameter> contains a table name,
<function>odbc_foreignkeys</function> returns a result set
containing the primary key of the specified table and all of the
foreign keys that refer to it.
</simpara>
<simpara>
If <parameter>fk_table</parameter> contains a table name,
<function>odbc_foreignkeys</function> returns a result set
containing all of the foreign keys in the specified table and the
primary keys (in other tables) to which they refer.
</simpara>
<simpara>
If both <parameter>pk_table</parameter> and
<parameter>fk_table</parameter> contain table names,
<function>odbc_foreignkeys</function> returns the foreign keys in
the table specified in <parameter>fk_table</parameter> that refer
to the primary key of the table specified in
<parameter>pk_table</parameter>. This should be one key at most.
</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;
&odbc.changelog.result-return;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>odbc_tables</function></member>
<member><function>odbc_primarykeys</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:"~/.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
-->
|
