pg_copy_from

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

pg_copy_from — Insère des lignes dans une table à partir d'un tableau

Description

pg_copy_from(
    PgSql\Connection $connection,
    string $table_name,
    array $rows,
    string $separator = "\t",
    string $null_as = "\\\\N"
): bool

pg_copy_from() insère les éléments du tableau rows dans une table. Cette fonction utilise la commande SQL interne COPY FROM.

Liste de paramètres

connection: Une instance PgSql\Connection.
table_name: Nom de la table dans laquelle rows sera copié.
rows: Un tableau de données à être copié à l'intérieur de table_name. Chaque valeur dans rows devient une ligne dans table_name. Chaque valeur dans rows devrait être une chaîne délimitée par des valeurs à insérer à l'intérieur de chaque champ. Les valeurs doivent être terminées par un saut à la ligne.
separator: Le marqueur qui sépare les valeurs pour chaque champ dans chaque élément de rows. Par défaut \t.
null_as: Comment les valeurs NULL de SQL sont représentées dans rows. Par défaut \\N ("\\\\N").

Valeurs de retour

Cette fonction retourne true en cas de succès ou false si une erreur survient.

Historique

Version	Description
8.1.0	Le paramètre `connection` attend désormais une instance de PgSql\Connection ; auparavant, une ressource était attendu.

Exemples

Exemple #1 Exemple avec pg_copy_from()

<?php
   $db = pg_connect("dbname=publisher") or die("Connexion impossible");
   
   $rows = pg_copy_to($db, $table_name);
   
   pg_query($db, "DELETE FROM $table_name");
   
   pg_copy_from($db, $table_name, $rows);
?>

Voir aussi

pg_copy_to() - Copie une table dans un tableau

add a note

User Contributed Notes 10 notes

down

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:
<?php
pg_copy_from($db, 'cpm.ics', $rows);
?>

Will import only specified columns:
<?php
pg_copy_from($db, 'cpm.ics (type, product, date, count, amount)', $rows);
?>

down

Dave ¶

10 years ago


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

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

down

Rainer Perske ¶

1 year ago


To solve the problem of how many backslashes to use for the parameters $separator and $null_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.

down

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.

down

Anonymous ¶

15 years ago


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

down

vlad at php dot net ¶

21 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)

down

-1

Dave ¶

12 years ago


As of postgresql 9.1 "standard_conforming_strings" is set to on

This will not work anymore
<?php
$copy_message = "1\t\\N\t300";
pg_copy_from($db, "message", $copy_message);
?>
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
<?php
$copy_message = "1\t\\NULL\t300";
pg_copy_from($db, "message", $copy_message, "\t","\\NULL");
?>

down

-1

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 !

down

-1

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.

down

-9

Dave ¶

13 years ago


Fix for "Copy command failed: ERROR: literal carriage return

found in data" or 

"Copy command failed: ERROR: missing data for column

"message" CONTEXT: COPY message, line 1:"



<?php

$message = "HEJ\rHEJ\nHEJ\r\nHEJ\n\rHEJ\tHELLO\\";



$message = addslashes($message);



$message = str_replace(

  array("\n","\r","\t"),

  array("\\n","\\r","\\t"),

  $message);



$copy_message = "1\t". $message ."\t300";



pg_copy_from($db, "message", $copy_message);

?>

add a note