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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="pdo-pgsql.copytofile" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<refnamediv>
<refname>Pdo\Pgsql::copyToFile</refname>
<refpurpose>Copy data from table into file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Pdo\\Pgsql">
<modifier>public</modifier> <type>bool</type><methodname>Pdo\Pgsql::copyToFile</methodname>
<methodparam><type>string</type><parameter>tableName</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>separator</parameter><initializer>"\t"</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>nullAs</parameter><initializer>"\\\\N"</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>fields</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<simpara>
Copies data from table into file specified by <parameter>filename</parameter>
using <parameter>separator</parameter> as fields delimiter and
<parameter>fields</parameter> list.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo-pgsql.copyfromarray')/db:refsect1[@role='parameters']//db:varlistentry[db:term[db:parameter[text()='tableName']]]/.)">
<xi:fallback><varlistentry><term></term><listitem><simpara></simpara></listitem></varlistentry></xi:fallback>
</xi:include>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<simpara>
Filename to export data.
</simpara>
</listitem>
</varlistentry>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo-pgsql.copyfromarray')/db:refsect1[@role='parameters']//db:varlistentry[db:term[db:parameter[text()='separator']]]/.)">
<xi:fallback><varlistentry><term></term><listitem><simpara></simpara></listitem></varlistentry></xi:fallback>
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo-pgsql.copyfromarray')/db:refsect1[@role='parameters']//db:varlistentry[db:term[db:parameter[text()='nullAs']]]/.)">
<xi:fallback><varlistentry><term></term><listitem><simpara></simpara></listitem></varlistentry></xi:fallback>
</xi:include>
<varlistentry>
<term><parameter>fields</parameter></term>
<listitem>
<simpara>
List of fields to insert.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.success;
</simpara>
</refsect1>
<!-- TODO?
<refsect1 role="errors">
&reftitle.errors;
<simpara>
When does this function issue <constant>E_*</constant> level errors,
and/or throw <exceptionname>Exception</exceptionname>s.
</simpara>
</refsect1>
-->
<!-- TODO?
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="pdo-pgsql.copytofile.example.basic">
<title><methodname>Pdo\Pgsql::copyToFile</methodname> example</title>
<simpara>
Description.
</simpara>
<programlisting role="php">
<![CDATA[
<?php
echo "Code example";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Code example
]]>
</screen>
</example>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<simpara>
Any notes that don't fit anywhere else should go here.
</simpara>
</note>
</refsect1>
-->
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>Pdo\Pgsql::copyFromFile</methodname></member>
<member><methodname>Pdo\Pgsql::copyFromArray</methodname></member>
<member><methodname>Pdo\Pgsql::copyToArray</methodname></member>
</simplelist>
</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:"~/.phpdoc/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
-->
|
