pg_copy_to

Function • Params changed in PHP 8.1

Copy a table to an array.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
Improved
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

pg_copy_to Function synopsis

pg_copy_to(
    PgSql\Connection $connection,
    string $table_name,
    string $separator = "\t",
    string $null_as = "\\\\N"
  ): array|false

Parameters

$connection

TypePgSql\Connection

$table_name

Typestring

Name of the table from which to copy the data into $rows.

$separator

OptionalTypestringDefault value"\t"

The token that separates values for each field in each element of $rows. Default is \t.

$null_as

OptionalTypestringDefault value"\\N"

How SQL NULL values are represented in the $rows. Default is \\N ("\\\\N").

Return value

Typearray|false

An array with one element for each line of COPY data, or false on failure.

Changes to the pg_copy_to Function

PHP 8.1

  • Parameter type added for parameter #1 ($connection): PgSql\Connection
  pg_copy_to(
-     $connection,
+     PgSql\Connection $connection,
      string $table_name,
      string $separator = "\t",
      string $null_as = "\\\\N"
    ): array|false

PHP 8.0

  • Return type added: array|false
  • Parameter type added for parameter #2 ($table_name): string
  • Parameter name of parameter #3 changed: $delimiter to $separator
  • Parameter type added for parameter #3 ($separator): string
  • Parameter default value added for position #3 ($separator): "\t"
  • Parameter type added for parameter #4 ($null_as): string
  • Parameter default value added for position #4 ($null_as): "\\\\N"
  pg_copy_to(
      $connection,
-     $table_name,
+     string $table_name,
-     $delimiter,
+     string $separator = "\t",
-     $null_as
+     string $null_as = "\\\\N"
-   )
+   ): array|false

pg_copy_to Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes