PostgreSQL 関数
PHP マニュアル

pg_escape_bytea

bytea フィールドに挿入するために文字列をエスケープする

説明

string pg_escape_bytea(PgSql\Connection $connection = ?, string $data)

pg_escape_bytea は、bytea 型のために文字列を エスケープし、エスケープした文字列を返します。

注意:

bytea 型を SELECT した場合、PostgreSQL は '\' で 始まる 8 進数のバイト値（例: \032）を返します。これをユーザーが手動で コンバートすることを期待されています。

この関数は PostgreSQL 7.2 以降のバージョンが必要です。PostgreSQL 7.2.0 および 7.2.1 では、マルチバイトのサポートを有効にした場合は bytea の値をキャストする必要があります。例: INSERT INTO test_table (image) VALUES ('$image_escaped'::bytea); PostgreSQL 7.2.2 以降ではキャストする必要はありません。 クライアントとバックエンドの文字エンコーディングが一致しない場合は 例外で、この場合はマルチバイトストリームエラーが発生します。この エラーを避けるためには bytea 型へのキャストが必要になります。

パラメータ

connection

PgSql\Connection クラスのインスタンス。 connection が指定されない場合は、デフォルトの接続を使います。 デフォルトの接続とは、pg_connect または pg_pconnect によって確立された直近の接続です。

警告

PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりました。

data

bytea 型のカラムに挿入するテキストまたはバイナリデータを含む 文字列。

戻り値

エスケープされたデータを文字列で返します。

変更履歴

バージョン 説明
8.1.0 connection は、PgSql\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、resource を期待していました。

例

例1 pg_escape_bytea の例

<?php 
  // データベースに接続する
  $dbconn = pg_connect('dbname=foo');
  
  // バイナリファイルを読み込む
  $data = file_get_contents('image1.jpg');
  
  // バイナリデータをエスケープする
  $escaped = pg_escape_bytea($data);
  
  // それをデータベースに挿入する
  pg_query("INSERT INTO gallery (name, data) VALUES ('Pine trees', '{$escaped}')");
?>

参考

  • pg_unescape_bytea
  • pg_escape_string