reference/uodbc/functions/odbc-primarykeys.xml
902c2b77f827e8d0ecccf4f62fb90065d2f6ef79
...
...
@@ -8,10 +8,10 @@
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
-
<type>resource</type><methodname>odbc_primarykeys</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>
11
+
<type class="union"><type>resource</type><type>false</type></type><methodname>odbc_primarykeys</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
15
<methodparam><type>string</type><parameter>table</parameter></methodparam>
16
16
</methodsynopsis>
17
17
<para>
...
...
@@ -24,22 +24,24 @@
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
+
&odbc.parameter.catalog;
36
37
</para>
37
38
</listitem>
38
39
</varlistentry>
39
40
<varlistentry>
40
-
<term><parameter>owner</parameter></term>
41
+
<term><parameter>schema</parameter></term>
41
42
<listitem>
42
43
<para>
44
+
&odbc.parameter.schema;
43
45
</para>
44
46
</listitem>
45
47
</varlistentry>
...
...
@@ -61,17 +63,65 @@
61
63
<para>
62
64
The result set has the following columns:
63
65
<itemizedlist>
64
-
<listitem><simpara>TABLE_QUALIFIER</simpara></listitem>
65
-
<listitem><simpara>TABLE_OWNER</simpara></listitem>
66
-
<listitem><simpara>TABLE_NAME</simpara></listitem>
67
-
<listitem><simpara>COLUMN_NAME</simpara></listitem>
68
-
<listitem><simpara>KEY_SEQ</simpara></listitem>
69
-
<listitem><simpara>PK_NAME</simpara></listitem>
66
+
<listitem><simpara><literal>TABLE_CAT</literal></simpara></listitem>
67
+
<listitem><simpara><literal>TABLE_SCHEM</literal></simpara></listitem>
68
+
<listitem><simpara><literal>TABLE_NAME</literal></simpara></listitem>
69
+
<listitem><simpara><literal>COLUMN_NAME</literal></simpara></listitem>
70
+
<listitem><simpara><literal>KEY_SEQ</literal></simpara></listitem>
71
+
<listitem><simpara><literal>PK_NAME</literal></simpara></listitem>
70
72
</itemizedlist>
73
+
&odbc.result.driver-specific;
74
+
</para>
75
+
<simpara>
76
+
The result set is ordered by <literal>TABLE_CAT</literal>, <literal>TABLE_SCHEM</literal>,
77
+
<literal>TABLE_NAME</literal> and <literal>KEY_SEQ</literal>.
78
+
</simpara>
79
+
</refsect1>
80
+

81
+
<refsect1 role="examples">
82
+
&reftitle.examples;
83
+
<example xml:id="odbc-primarykeys.example.basic">
84
+
<title>List primary Keys of a Column</title>
85
+
<programlisting role="php">
86
+
<![CDATA[
87
+
<?php
88
+
$conn = odbc_connect($dsn, $user, $pass);
89
+
$primarykeys = odbc_primarykeys($conn, 'TutorialDB', 'dbo', 'TEST');
90
+
while (($row = odbc_fetch_array($primarykeys))) {
91
+
print_r($row);
92
+
break; // further rows omitted for brevity
93
+
}
94
+
?>
95
+
]]>
96
+
</programlisting>
97
+
&example.outputs.similar;
98
+
<screen>
99
+
<![CDATA[
100
+
Array
101
+
(
102
+
[TABLE_CAT] => TutorialDB
103
+
[TABLE_SCHEM] => dbo
104
+
[TABLE_NAME] => TEST
105
+
[COLUMN_NAME] => id
106
+
[KEY_SEQ] => 1
107
+
[PK_NAME] => PK__TEST__3213E83FE141F843
108
+
)
109
+
]]>
110
+
</screen>
111
+
</example>
112
+
</refsect1>
113
+

114
+
<refsect1 role="seealso">
115
+
&reftitle.seealso;
116
+
<para>
117
+
<simplelist>
118
+
<member><function>odbc_tables</function></member>
119
+
<member><function>odbc_foreignkeys</function></member>
120
+
</simplelist>
71
121
</para>
72
122
</refsect1>
73
-
</refentry>
74
123

124
+
</refentry>
75
125
<!-- Keep this comment at the end of the file
76
126
Local variables:
77
127
mode: sgml
78
128