PHP: Hypertext Preprocessor (original) (raw)

pg_copy_from

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

pg_copy_from — Insert records into a table from an array

Description

Parameters

connection

An PgSql\Connection instance.

table_name

Name of the table into which to copy the rows.

rows

An array of data to be copied into table_name. Each value in rows becomes a row in table_name. Each value in rows should be a delimited string of the values to insert into each field. Values should be linefeed terminated.

separator

The token that separates values for each field in each element ofrows. Default is \t.

null_as

How SQL NULL values are represented in therows. Default is \\N ("\\\\N").

Return Values

Returns [true](reserved.constants.php#constant.true) on success or [false](reserved.constants.php#constant.false) on failure.

Changelog

Version	Description
8.1.0	The connection parameter expects an PgSql\Connection instance now; previously, a resource was expected.

Examples

Example #1 pg_copy_from() example

<?php <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>d</mi><mi>b</mi><mo>=</mo><mi>p</mi><msub><mi>g</mi><mi>c</mi></msub><mi>o</mi><mi>n</mi><mi>n</mi><mi>e</mi><mi>c</mi><mi>t</mi><mo stretchy="false">(</mo><mi mathvariant="normal">"</mi><mi>d</mi><mi>b</mi><mi>n</mi><mi>a</mi><mi>m</mi><mi>e</mi><mo>=</mo><mi>p</mi><mi>u</mi><mi>b</mi><mi>l</mi><mi>i</mi><mi>s</mi><mi>h</mi><mi>e</mi><mi>r</mi><mi mathvariant="normal">"</mi><mo stretchy="false">)</mo><mi>o</mi><mi>r</mi><mi>d</mi><mi>i</mi><mi>e</mi><mo stretchy="false">(</mo><mi mathvariant="normal">"</mi><mi>C</mi><mi>o</mi><mi>u</mi><mi>l</mi><mi>d</mi><mi>n</mi><mi>o</mi><mi>t</mi><mi>c</mi><mi>o</mi><mi>n</mi><mi>n</mi><mi>e</mi><mi>c</mi><mi>t</mi><mi mathvariant="normal">"</mi><mo stretchy="false">)</mo><mo separator="true">;</mo></mrow><annotation encoding="application/x-tex">db = pg_connect("dbname=publisher") or die("Could not connect");</annotation></semantics></math>db=pgconnect("dbname=publisher")ordie("Couldnotconnect");rows = pg_copy_to($db, <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>t</mi><mi>a</mi><mi>b</mi><mi>l</mi><msub><mi>e</mi><mi>n</mi></msub><mi>a</mi><mi>m</mi><mi>e</mi><mo stretchy="false">)</mo><mo separator="true">;</mo><mi>p</mi><msub><mi>g</mi><mi>q</mi></msub><mi>u</mi><mi>e</mi><mi>r</mi><mi>y</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">table_name);pg_query(</annotation></semantics></math>tablename);pgquery(db, "DELETE FROM <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>t</mi><mi>a</mi><mi>b</mi><mi>l</mi><msub><mi>e</mi><mi>n</mi></msub><mi>a</mi><mi>m</mi><mi>e</mi><mi mathvariant="normal">"</mi><mo stretchy="false">)</mo><mo separator="true">;</mo><mi>p</mi><msub><mi>g</mi><mi>c</mi></msub><mi>o</mi><mi>p</mi><msub><mi>y</mi><mi>f</mi></msub><mi>r</mi><mi>o</mi><mi>m</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">table_name");pg_copy_from(</annotation></semantics></math>tablename");pgcopyfrom(db, <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>t</mi><mi>a</mi><mi>b</mi><mi>l</mi><msub><mi>e</mi><mi>n</mi></msub><mi>a</mi><mi>m</mi><mi>e</mi><mo separator="true">,</mo></mrow><annotation encoding="application/x-tex">table_name, </annotation></semantics></math>tablename,rows); ?>

Found A Problem?

karlo dot petravic at hotmail dot com ¶

5 years ago

`As table name you can also specify columns you want imported.

Will import all columns:

Will import only specified columns:

Rainer Perske ¶

2 years ago

`To solve the problem of how many backslashes to use for the parameters separatorandseparator and separatorandnull_as: The backslashes are interpreted twice, first by PHP and then by PostgreSQL. So write four backslashes to indicate one backslash in the input data. So both '\\N' and as "\\N" become NULL AS E'\N' meaning the same as NULL AS '\N' in the internally used SQL statement.

The loaded input data must be backslash-escaped. According to the PostgreSQL documentation, you can use the following escape sequences:

\ = Backslash (ASCII 92)
\b = Backspace (ASCII 8)
\t = Tab (ASCII 9)
\n = Newline (ASCII 10)
\v = Vertical tab (ASCII 11)
\f = Form feed (ASCII 12)
\r = Carriage return (ASCII 13)
\000 (Backslash followed by one to three octal digits) = the byte with that numeric code
\x00 (Backslash x followed by one or two hex digits) = the byte with that numeric code

With the default setting, a data field containing only \N (one non-escaped backslash and an N) indicates a NULL value. This default value \N has been chosen because it does not collide with properly encoded data.

smcbride at msn dot com ¶

4 years ago

`When using this function, don't get bit by the double quote (") vs. single quote (') differences. It is a small thing, but the error messaging is misleading. If you use a single quote, you will see the \t separated values all try to be inserted into the first field.

Small consideration, but will save someone who is working late and can't get these functions to work.

Anonymous ¶

15 years ago

see also: pg_put_line for a solution that does not require buffering of all the data to be copied,

Dave ¶

11 years ago

`Default is "\\N" not "\N" at least in php 5.4

pg_copy_from($db, $table_name, "\t", "\\N")

vlad at php dot net ¶

22 years ago

`By default NULL values are a backslash followed with capital N ("\N").

Also, you can't insert entries with OIDs (I've added it to my TODO list though)

Dave ¶

13 years ago

`As of postgresql 9.1 "standard_conforming_strings" is set to on

This will not work anymore

result will be a "N" in that field. if the field allow text that is else it will fail to insert the post.

simple fix

kapouer_php at melix dot org ¶

17 years ago

`pg syntax is :
COPY test (cola, colb, colc) FROM stdin;
...

this function doesn't let you in which order the columns are !

carl at thep.lu.se ¶

22 years ago

`Something needs to be said about the format of the array.
Judging by what I've seen, it's pretty much what you get
from loading a tab-separated file with file(). That is, the
lines are linefeed-terminated and there's no need to have
an extra line with ".". On the other hand, when I try using this
command the connection to the server ends up in some odd
state and is then lost:
PHP Warning: U?S?o() query failed: server closed the connection unexpectedly

I think it might be safer to use the lower-level function
pg_put_line() for now.