Pg set client encoding: примеры (PHP)

Примеры использования

<?php
$conn = pg_connect("host=localhost dbname=test user=postgres");
$result = pg_set_client_encoding($conn, "UTF8");
if ($result === 0) {
    echo "Кодировка установлена успешно.";
} else {
    echo "Произошла ошибка.";
}
?>

Кодировка установлена успешно.

<?php
pg_connect("host=localhost dbname=test user=postgres");
$result = pg_set_client_encoding("WIN1251");
echo $result === 0 ? "Успешно" : "Ошибка";
?>

Успешно

<?php
$conn = pg_connect("host=localhost dbname=test user=postgres");
$result = pg_set_client_encoding($conn, "UNKNOWN_ENCODING");
echo $result === -1 ? "Ошибка установки кодировки." : "Успешно";
?>

Ошибка установки кодировки.

Альтернативные функции в PHP

В PHP существуют другие функции для работы с кодировками при взаимодействии с PostgreSQL. pg_client_encoding возвращает текущую кодировку клиента без возможности изменения. Эта функция полезна для получения информации о текущих настройках. SET NAMES в SQL-запросе выполняет аналогичную задачу, но на уровне SQL. Прямое использование SQL-команды позволяет менять кодировку в рамках транзакции.

Функция pg_set_client_encoding является предпочтительной для явного управления кодировкой на уровне PHP-кода. SQL-команда SET NAMES может быть использована в сложных сценариях, где требуется изменение кодировки в составе транзакции. Функция pg_client_encoding используется только для диагностики.

Альтернативы в других языках

import psycopg2
conn = psycopg2.connect("dbname=test user=postgres")
conn.set_client_encoding('UTF8')
print(conn.encoding)

UTF8

const { Client } = require('pg');
const client = new Client();
await client.connect();
await client.query("SET client_encoding TO 'UTF8'");
console.log('Кодировка установлена');

Кодировка установлена

Pg set client encoding в MySQL

SET NAMES utf8mb4;

Query OK, 0 rows affected (0.00 sec)

В отличие от PHP, в Python и Node.js управление кодировкой часто интегрировано в объекты соединения. В MySQL используется SQL-команда SET NAMES, которая меняет кодировку соединения аналогично PostgreSQL.

Типичные ошибки

<?php
$conn = pg_connect("host=localhost dbname=test user=postgres");
$result = pg_set_client_encoding($conn, null);
var_dump($result);
?>

int(-1)

<?php
$result = pg_set_client_encoding("UTF8");
var_dump($result);
?>

Warning: pg_set_client_encoding(): No PostgreSQL link opened yet in ...
bool(false)

<?php
$conn = pg_connect("host=localhost dbname=test user=postgres");
pg_query($conn, "INSERT INTO users (name) VALUES ('Иван')");
pg_set_client_encoding($conn, "UTF8");
$res = pg_query($conn, "SELECT name FROM users");
$row = pg_fetch_assoc($res);
echo $row['name'];
?>

Иван (может отображаться некорректно, если первоначальная кодировка была другой)

Ошибки часто возникают при попытке изменить кодировку после выполнения запросов или при использовании неподдерживаемых значений.

Изменения в версиях PHP

В PHP 8.0 функция pg_set_client_encoding была перенесена из стандартного расширения pgsql в расширение pgsql, которое теперь всегда доступно при сборке с поддержкой PostgreSQL. Сигнатура функции осталась неизменной. В PHP 8.1 улучшена обработка ошибок при передаче неверных параметров. В ранних версиях PHP функция могла возвращать false при ошибке, теперь возвращает -1 для сохранения обратной совместимости.

Расширенные примеры

<?php
$conn = pg_connect("host=localhost dbname=test user=postgres");
$encoding = mb_detect_encoding(file_get_contents('data.txt'), ['UTF-8', 'Windows-1251'], true);
if ($encoding === 'UTF-8') {
    pg_set_client_encoding($conn, "UTF8");
} elseif ($encoding === 'Windows-1251') {
    pg_set_client_encoding($conn, "WIN1251");
}
?>

Кодировка установлена в зависимости от содержимого файла.

<?php
function setPgEncoding($conn, $encoding) {
    $result = pg_set_client_encoding($conn, $encoding);
    if ($result === -1) {
        throw new Exception("Не удалось установить кодировку: " . pg_last_error($conn));
    }
    return true;
}
try {
    $conn = pg_connect("host=localhost dbname=test user=postgres");
    setPgEncoding($conn, "UTF8");
    echo "Успешно";
} catch (Exception $e) {
    echo $e->getMessage();
}
?>

Успешно

<?php
class PostgreSQLConnection {
    private $conn;
    public function __construct($params) {
        $this->conn = pg_connect($params);
    }
    public function setEncoding($encoding) {
        if (pg_set_client_encoding($this->conn, $encoding) === -1) {
            throw new RuntimeException('Ошибка установки кодировки');
        }
    }
    public function getEncoding() {
        return pg_client_encoding($this->conn);
    }
}
$db = new PostgreSQLConnection("host=localhost dbname=test user=postgres");
$db->setEncoding('KOI8');
echo $db->getEncoding();
?>

KOI8

<?php
$conn = pg_connect("host=localhost dbname=test user=postgres");
pg_query($conn, "BEGIN");
pg_set_client_encoding($conn, "WIN1251");
pg_query($conn, "INSERT INTO logs (message) VALUES ('Сообщение в WIN1251')");
pg_set_client_encoding($conn, "UTF8");
pg_query($conn, "INSERT INTO logs (message) VALUES ('Сообщение в UTF8')");
pg_query($conn, "COMMIT");
?>

Данные записаны в разных кодировках в рамках одной транзакции.