doc-ja/reference/pdo_pgsql/pdo/pgsql/copyfromarray.xml at 4da8c8f04d32579d73932a682025f1e107d36b95 · takaram/doc-ja · GitHub

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
137
138
139
140
141
142
143
144
145
146
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 9b69a8dcce47d6619d6459914e784627cbb02a5f Maintainer: KentarouTakeda Status: ready -->
<!-- CREDITS: mumumu,KentarouTakeda -->
<refentry xml:id="pdo-pgsql.copyfromarray" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>Pdo\Pgsql::copyFromArray</refname>
  <refpurpose>PHP の配列から、データをテーブルにコピーする</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="Pdo\\Pgsql">
   <modifier>public</modifier> <type>bool</type><methodname>Pdo\Pgsql::copyFromArray</methodname>
   <methodparam><type>string</type><parameter>tableName</parameter></methodparam>
   <methodparam><type>array</type><parameter>rows</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>
   <parameter>rows</parameter> 配列からデータをテーブル
   <parameter>tableName</parameter> にコピーします。その際、<parameter>separator</parameter> を
   フィールドのデリミタ、そして <parameter>fields</parameter> のリストを使います。
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>tableName</parameter></term>
    <listitem>
     <simpara>
      テーブル名を含む文字列
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>rows</parameter></term>
    <listitem>
     <simpara>
      <parameter>separator</parameter> で区切られたフィールドの文字列の配列
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>separator</parameter></term>
    <listitem>
     <simpara>
      <parameter>rows</parameter> 配列の各要素の中で
      フィールドを分割するためのデリミタ
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>nullAs</parameter></term>
    <listitem>
     <simpara>
      SQLの <literal>NULL</literal> 値をどのように扱うかを指定します
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>fields</parameter></term>
    <listitem>
     <simpara>
      挿入するフィールドの一覧
     </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.copyfromarray.example.basic">
   <title><methodname>Pdo\Pgsql::copyFromArray</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="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>Pdo\Pgsql::copyToArray</methodname></member>
   <member><methodname>Pdo\Pgsql::copyFromFile</methodname></member>
   <member><methodname>Pdo\Pgsql::copyToFile</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
-->