php-doc-en/reference/pdo_pgsql/PDO/pgsqlCopyFromArray.xml
Peter Cowburn 02312b8f5f concise return value descriptions
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@336779 c90b9560-bf6c-de11-be94-00142212c4b1
2015-05-15 11:58:57 +00:00

99 lines
2.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="pdo.pgsqlcopyfromarray" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>PDO::pgsqlCopyFromArray</refname>
<refpurpose>Copy data from PHP array into table</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type> <methodname>PDO::pgsqlCopyFromArray</methodname>
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
<methodparam><type>array</type><parameter>rows</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>delimiter</parameter><initializer>'\t'</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>null_as</parameter><initializer>"\\\\N"</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>fields</parameter></methodparam>
</methodsynopsis>
<para>
Copies data from <parameter>rows</parameter> array to table <parameter>table_name</parameter>
using <parameter>delimiter</parameter> as fields delimiter and <parameter>fields</parameter> list
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>table_name</parameter></term>
<listitem>
<para>
String containing table name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rows</parameter></term>
<listitem>
<para>
Array of strings with fields separated by <parameter>delimiter</parameter>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>delimiter</parameter></term>
<listitem>
<para>
Delimiter used in <parameter>rows</parameter> array
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>null_as</parameter></term>
<listitem>
<para>
How to interpret null values
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fields</parameter></term>
<listitem>
<para>
List of fields to insert
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; on success,&return.falseforfailure;.
</para>
</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
-->