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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.3 -->
<refentry id="function.odbc-foreignkeys">
<refnamediv>
<refname>odbc_foreignkeys</refname>
<refpurpose>
Returns 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
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>odbc_foreignkeys</methodname>
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
<methodparam><type>string</type><parameter>pk_qualifier</parameter></methodparam>
<methodparam><type>string</type><parameter>pk_owner</parameter></methodparam>
<methodparam><type>string</type><parameter>pk_table</parameter></methodparam>
<methodparam><type>string</type><parameter>fk_qualifier</parameter></methodparam>
<methodparam><type>string</type><parameter>fk_owner</parameter></methodparam>
<methodparam><type>string</type><parameter>fk_table</parameter></methodparam>
</methodsynopsis>
<para>
<function>odbc_foreignkeys</function> retrieves information about
foreign keys. Returns an ODBC result identifier or
&false; on failure.
</para>
<para>
The result set has the following columns:
<itemizedlist>
<listitem><simpara>PKTABLE_QUALIFIER</simpara></listitem>
<listitem><simpara>PKTABLE_OWNER</simpara></listitem>
<listitem><simpara>PKTABLE_NAME</simpara></listitem>
<listitem><simpara>PKCOLUMN_NAME</simpara></listitem>
<listitem><simpara>FKTABLE_QUALIFIER</simpara></listitem>
<listitem><simpara>FKTABLE_OWNER</simpara></listitem>
<listitem><simpara>FKTABLE_NAME</simpara></listitem>
<listitem><simpara>FKCOLUMN_NAME</simpara></listitem>
<listitem><simpara>KEY_SEQ</simpara></listitem>
<listitem><simpara>UPDATE_RULE</simpara></listitem>
<listitem><simpara>DELETE_RULE</simpara></listitem>
<listitem><simpara>FK_NAME</simpara></listitem>
<listitem><simpara>PK_NAME</simpara></listitem>
</itemizedlist>
</para>
<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>
</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
-->
|
