reference/pgsql/functions/pg-field-num.xml
6fcf14255c6027d7adf48a5f71f6a1c9a12018b2
6fcf14255c6027d7adf48a5f71f6a1c9a12018b2
...
...
@@ -11,14 +11,13 @@
11
11
&reftitle.description;
12
12
<methodsynopsis>
13
13
<type>int</type><methodname>pg_field_num</methodname>
14
-
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
15
-
<methodparam><type>string</type><parameter>field_name</parameter></methodparam>
14
+
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
15
+
<methodparam><type>string</type><parameter>field</parameter></methodparam>
16
16
</methodsynopsis>
17
17
<para>
18
18
<function>pg_field_num</function> will return the number of the
19
19
field number that corresponds to the
20
-
<parameter>field_name</parameter> in the given PostgreSQL
21
-
<parameter>result</parameter> resource.
20
+
<parameter>field</parameter> in the given <parameter>result</parameter> instance.
22
21
</para>
23
22
<note>
24
23
<para>
...
...
@@ -34,18 +33,16 @@
34
33
<varlistentry>
35
34
<term><parameter>result</parameter></term>
36
35
<listitem>
37
-
<para>
38
-
PostgreSQL query result resource, returned by <function>pg_query</function>,
39
-
<function>pg_query_params</function> or <function>pg_execute</function>
40
-
(among others).
41
-
</para>
36
+
&pgsql.parameter.result;
42
37
</listitem>
43
38
</varlistentry>
44
39
<varlistentry>
45
-
<term><parameter>field_name</parameter></term>
40
+
<term><parameter>field</parameter></term>
46
41
<listitem>
47
42
<para>
48
43
The name of the field.
44
+
The given name is treated like an identifier in an SQL command,
45
+
that is, it is downcased unless double-quoted.
49
46
</para>
50
47
</listitem>
51
48
</varlistentry>
...
...
@@ -60,6 +57,23 @@
60
57
</para>
61
58
</refsect1>
62
59
60
+
<refsect1 role="changelog">
61
+
&reftitle.changelog;
62
+
<informaltable>
63
+
<tgroup cols="2">
64
+
<thead>
65
+
<row>
66
+
<entry>&Version;</entry>
67
+
<entry>&Description;</entry>
68
+
</row>
69
+
</thead>
70
+
<tbody>
71
+
&pgsql.changelog.result-object;
72
+
</tbody>
73
+
</tgroup>
74
+
</informaltable>
75
+
</refsect1>
76
+
63
77
<refsect1 role="examples">
64
78
&reftitle.examples;
65
79
<para>
...
...
@@ -95,7 +109,6 @@ Column 'title' is field number: 2
95
109
</para>
96
110
</refsect1>
97
111
</refentry>
98
-
99
112
<!-- Keep this comment at the end of the file
100
113
Local variables:
101
114
mode: sgml
102
115