reference/uodbc/functions/odbc-foreignkeys.xml
3ec1a6204f5086b0cac4b087727a9a5a18075f9d
...
...
@@ -9,13 +9,13 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>resource</type><methodname>odbc_foreignkeys</methodname>
13
-
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
14
-
<methodparam><type>string</type><parameter>pk_qualifier</parameter></methodparam>
15
-
<methodparam><type>string</type><parameter>pk_owner</parameter></methodparam>
12
+
<type class="union"><type>resource</type><type>false</type></type><methodname>odbc_foreignkeys</methodname>
13
+
<methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
14
+
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>pk_catalog</parameter></methodparam>
15
+
<methodparam><type>string</type><parameter>pk_schema</parameter></methodparam>
16
16
<methodparam><type>string</type><parameter>pk_table</parameter></methodparam>
17
-
<methodparam><type>string</type><parameter>fk_qualifier</parameter></methodparam>
18
-
<methodparam><type>string</type><parameter>fk_owner</parameter></methodparam>
17
+
<methodparam><type>string</type><parameter>fk_catalog</parameter></methodparam>
18
+
<methodparam><type>string</type><parameter>fk_schema</parameter></methodparam>
19
19
<methodparam><type>string</type><parameter>fk_table</parameter></methodparam>
20
20
</methodsynopsis>
21
21
<para>
...
...
@@ -30,24 +30,24 @@
30
30
<para>
31
31
<variablelist>
32
32
<varlistentry>
33
-
<term><parameter>connection_id</parameter></term>
33
+
<term><parameter>odbc</parameter></term>
34
34
<listitem>
35
35
&odbc.connection.id;
36
36
</listitem>
37
37
</varlistentry>
38
38
<varlistentry>
39
-
<term><parameter>pk_qualifier</parameter></term>
39
+
<term><parameter>pk_catalog</parameter></term>
40
40
<listitem>
41
41
<para>
42
-
The primary key qualifier.
42
+
The catalog (&apos;qualifier&apos; in ODBC 2 parlance) of the primary key table.
43
43
</para>
44
44
</listitem>
45
45
</varlistentry>
46
46
<varlistentry>
47
-
<term><parameter>pk_owner</parameter></term>
47
+
<term><parameter>pk_schema</parameter></term>
48
48
<listitem>
49
49
<para>
50
-
The primary key owner.
50
+
The schema (&apos;owner&apos; in ODBC 2 parlance) of the primary key table.
51
51
</para>
52
52
</listitem>
53
53
</varlistentry>
...
...
@@ -60,18 +60,18 @@
60
60
</listitem>
61
61
</varlistentry>
62
62
<varlistentry>
63
-
<term><parameter>fk_qualifier</parameter></term>
63
+
<term><parameter>fk_catalog</parameter></term>
64
64
<listitem>
65
65
<para>
66
-
The foreign key qualifier.
66
+
The catalog (&apos;qualifier&apos; in ODBC 2 parlance) of the foreign key table.
67
67
</para>
68
68
</listitem>
69
69
</varlistentry>
70
70
<varlistentry>
71
-
<term><parameter>fk_owner</parameter></term>
71
+
<term><parameter>fk_schema</parameter></term>
72
72
<listitem>
73
73
<para>
74
-
The foreign key owner.
74
+
The schema (&apos;owner&apos; in ODBC 2 parlance) of the foreign key table.
75
75
</para>
76
76
</listitem>
77
77
</varlistentry>
...
...
@@ -95,22 +95,32 @@
95
95
<para>
96
96
The result set has the following columns:
97
97
<itemizedlist>
98
-
<listitem><simpara>PKTABLE_QUALIFIER</simpara></listitem>
99
-
<listitem><simpara>PKTABLE_OWNER</simpara></listitem>
100
-
<listitem><simpara>PKTABLE_NAME</simpara></listitem>
101
-
<listitem><simpara>PKCOLUMN_NAME</simpara></listitem>
102
-
<listitem><simpara>FKTABLE_QUALIFIER</simpara></listitem>
103
-
<listitem><simpara>FKTABLE_OWNER</simpara></listitem>
104
-
<listitem><simpara>FKTABLE_NAME</simpara></listitem>
105
-
<listitem><simpara>FKCOLUMN_NAME</simpara></listitem>
106
-
<listitem><simpara>KEY_SEQ</simpara></listitem>
107
-
<listitem><simpara>UPDATE_RULE</simpara></listitem>
108
-
<listitem><simpara>DELETE_RULE</simpara></listitem>
109
-
<listitem><simpara>FK_NAME</simpara></listitem>
110
-
<listitem><simpara>PK_NAME</simpara></listitem>
98
+
<listitem><simpara><literal>PKTABLE_CAT</literal></simpara></listitem>
99
+
<listitem><simpara><literal>PKTABLE_SCHEM</literal></simpara></listitem>
100
+
<listitem><simpara><literal>PKTABLE_NAME</literal></simpara></listitem>
101
+
<listitem><simpara><literal>PKCOLUMN_NAME</literal></simpara></listitem>
102
+
<listitem><simpara><literal>FKTABLE_CAT</literal></simpara></listitem>
103
+
<listitem><simpara><literal>FKTABLE_SCHEM</literal></simpara></listitem>
104
+
<listitem><simpara><literal>FKTABLE_NAME</literal></simpara></listitem>
105
+
<listitem><simpara><literal>FKCOLUMN_NAME</literal></simpara></listitem>
106
+
<listitem><simpara><literal>KEY_SEQ</literal></simpara></listitem>
107
+
<listitem><simpara><literal>UPDATE_RULE</literal></simpara></listitem>
108
+
<listitem><simpara><literal>DELETE_RULE</literal></simpara></listitem>
109
+
<listitem><simpara><literal>FK_NAME</literal></simpara></listitem>
110
+
<listitem><simpara><literal>PK_NAME</literal></simpara></listitem>
111
+
<listitem><simpara><literal>DEFERRABILITY</literal></simpara></listitem>
111
112
</itemizedlist>
113
+
&odbc.result.driver-specific;
112
114
</para>
113
115
<simpara>
116
+
If the foreign keys associated with a primary key are requested, the result set
117
+
is ordered by <literal>FKTABLE_CAT</literal>, <literal>FKTABLE_SCHEM</literal>,
118
+
<literal>FKTABLE_NAME</literal> and <literal>KEY_SEQ</literal>.
119
+
If the primary keys associated with a foreign key are requested, the result set
120
+
is ordered by <literal>PKTABLE_CAT</literal>, <literal>PKTABLE_SCHEM</literal>,
121
+
<literal>PKTABLE_NAME</literal> and <literal>KEY_SEQ</literal>.
122
+
</simpara>
123
+
<simpara>
114
124
If <parameter>pk_table</parameter> contains a table name,
115
125
<function>odbc_foreignkeys</function> returns a result set
116
126
containing the primary key of the specified table and all of the
...
...
@@ -132,8 +142,17 @@
132
142
</simpara>
133
143
</refsect1>
134
144

135
-
</refentry>
145
+
<refsect1 role="seealso">
146
+
&reftitle.seealso;
147
+
<para>
148
+
<simplelist>
149
+
<member><function>odbc_tables</function></member>
150
+
<member><function>odbc_primarykeys</function></member>
151
+
</simplelist>
152
+
</para>
153
+
</refsect1>
136
154

155
+
</refentry>
137
156
<!-- Keep this comment at the end of the file
138
157
Local variables:
139
158
mode: sgml
140
159



Tools (Spanish Manual)