Home/ Manual/ pdo / pgsql/ Pdo\Pgsql::copyToFile

Pdo\Pgsql::copyToFile

PHP function Edit on GitHub ✎

(PHP 8 >= 8.4.0)

Copy data from table into file

Description

Pdo\Pgsql::copyToFile(string $tableName, string $filename, string $separator = "\t", string $nullAs = "\\\\N", string|null $fields = null): bool

Copies data from table into file specified by filename using separator as fields delimiter and fields list.

Parameters

filename: Filename to export data.
fields: List of fields to export.

Return Values

Success

Errors/Exceptions

If filename cannot be opened for writing, or cannot be written to, the failure is reported through the connection's error handling (see PDO::ATTR_ERRMODE); with PDO::ERRMODE_EXCEPTION a PDOException is thrown.

Examples

Pdo\Pgsql::copyToFile example

The table is written to filename, one record per line, with fields joined by separator.

php

<?php
$db = new Pdo\Pgsql('pgsql:dbname=test host=localhost', $user, $pass);
$db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
$db->exec('CREATE TABLE fruits (id int, name text, qty int)');
$db->exec("INSERT INTO fruits VALUES (1, 'apple', 10), (2, 'banana', 20)");

$db->copyToFile('fruits', '/tmp/fruits.tsv');
echo file_get_contents('/tmp/fruits.tsv');
?>

The above example will output:

output

1	apple	10
2	banana	20