reference/pgsql/functions/pg-meta-data.xml
c2eca73ef79ebe78cebb34053e41b565af504c4f
c2eca73ef79ebe78cebb34053e41b565af504c4f
...
...
@@ -1,7 +1,7 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
3
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.80 -->
4
-
<refentry xml:id='function.pg-meta-data' xmlns="http://docbook.org/ns/docbook">
4
+
<refentry xml:id="function.pg-meta-data" xmlns="http://docbook.org/ns/docbook">
5
5
<refnamediv>
6
6
<refname>pg_meta_data</refname>
7
7
<refpurpose>
...
...
@@ -12,15 +12,15 @@
12
12
<refsect1 role="description">
13
13
&reftitle.description;
14
14
<methodsynopsis>
15
-
<type>array</type><methodname>pg_meta_data</methodname>
16
-
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
15
+
<type class="union"><type>array</type><type>false</type></type><methodname>pg_meta_data</methodname>
16
+
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
17
17
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
18
+
<methodparam choice="opt"><type>bool</type><parameter>extended</parameter><initializer>&false;</initializer></methodparam>
18
19
</methodsynopsis>
19
20
<para>
20
21
<function>pg_meta_data</function> returns table definition for
21
22
<literal>table_name</literal> as an array.
22
23
</para>
23
-
&warn.experimental.func;
24
24
</refsect1>
25
25
26
26
<refsect1 role="parameters">
...
...
@@ -30,9 +30,7 @@
30
30
<varlistentry>
31
31
<term><parameter>connection</parameter></term>
32
32
<listitem>
33
-
<para>
34
-
PostgreSQL database connection resource.
35
-
</para>
33
+
&pgsql.parameter.connection;
36
34
</listitem>
37
35
</varlistentry>
38
36
<varlistentry>
...
...
@@ -43,6 +41,14 @@
43
41
</para>
44
42
</listitem>
45
43
</varlistentry>
44
+
<varlistentry>
45
+
<term><parameter>extended</parameter></term>
46
+
<listitem>
47
+
<para>
48
+
Flag for returning extended meta data. Default to &false;.
49
+
</para>
50
+
</listitem>
51
+
</varlistentry>
46
52
</variablelist>
47
53
</para>
48
54
</refsect1>
...
...
@@ -50,10 +56,27 @@
50
56
<refsect1 role="returnvalues">
51
57
&reftitle.returnvalues;
52
58
<para>
53
-
An <type>array</type> of the table definition, or &false; on error.
59
+
An <type>array</type> of the table definition, &return.falseforfailure;.
54
60
</para>
55
61
</refsect1>
56
62
63
+
<refsect1 role="changelog">
64
+
&reftitle.changelog;
65
+
<informaltable>
66
+
<tgroup cols="2">
67
+
<thead>
68
+
<row>
69
+
<entry>&Version;</entry>
70
+
<entry>&Description;</entry>
71
+
</row>
72
+
</thead>
73
+
<tbody>
74
+
&pgsql.changelog.connection-object;
75
+
</tbody>
76
+
</tgroup>
77
+
</informaltable>
78
+
</refsect1>
79
+
57
80
<refsect1 role="examples">
58
81
&reftitle.examples;
59
82
<para>
...
...
@@ -132,7 +155,6 @@ array(5) {
132
155
</para>
133
156
</refsect1>
134
157
</refentry>
135
-
136
158
<!-- Keep this comment at the end of the file
137
159
Local variables:
138
160
mode: sgml
139
161