説明

pg_insert(
    PgSql\Connection $connection,
    string $table_name,
    array $values,
    int $flags = PGSQL_DML_EXEC
): PgSql\Result|string|bool

pg_insert() は、 table_name で指定したテーブルに values の値を挿入します。

flags が指定されている場合、そのオプションとともに pg_convert() が values に適用されます。

デフォルトでは、 pg_insert() は生の値を渡します。値はエスケープするか、 flags に PGSQL_DML_ESCAPE オプションを指定しなければいけません。 PGSQL_DML_ESCAPE はパラメータや識別子をクォートし、エスケープします。よって、テーブル/カラム名は大文字小文字を区別します。

エスケープやプリペアドクエリであっても、 LIKE, JSON, Array, Regex などのクエリを守れない可能性があることに注意してください。これらのパラメータはコンテクストに応じて処理されるべきです。たとえば、値をエスケープ/検証する処理を行うことなどです。

パラメータ

connection: PgSql\Connection クラスのインスタンス。
table_name: 行を挿入するテーブルの名前。テーブル table_name は、少なくとも values の要素数ぶんのカラムを保持している必要があります。
values: テーブル table_name のフィールド名をキーに、挿入する内容を値にもつ配列。
flags: PGSQL_CONV_OPTS、 PGSQL_DML_NO_CONV、 PGSQL_DML_ESCAPE、 PGSQL_DML_EXEC、 PGSQL_DML_ASYNC あるいは PGSQL_DML_STRING を組み合わせた数。 PGSQL_DML_STRING が flags に含まれていた場合、クエリ文字列が返されます。 PGSQL_DML_NO_CONV あるいは PGSQL_DML_ESCAPE が設定されている場合は、内部的に pg_convert() を呼びません。

戻り値

成功した場合に true を、失敗した場合に false を返します。 flags で PGSQL_DML_STRING が渡された場合は、成功時に文字列を返します。

エラー / 例外

指定したテーブルが無効な場合、ValueError がスローされます。

値やフィールドの型が PostgreSQL の型と一致しない場合、 ValueError または TypeError がスローされます。

変更履歴

バージョン	説明
8.3.0	指定されたテーブルが無効な場合、 ValueError がスローされるようになりました。これより前のバージョンでは、`E_WARNING` が発生していました。
8.3.0	値やフィールドの型が PostgreSQL の型と一致しない場合、 ValueError または TypeError がスローされるようになりました。これより前のバージョンでは、`E_WARNING` が発生していました。
8.1.0	PgSql\Result クラスのインスタンスを返すようになりました。これより前のバージョンでは、resource を返していました。
8.1.0	`connection` は、PgSql\Connection クラスのインスタンスを期待するようになりました。これより前のバージョンでは、resource を期待していました。

例

例1 pg_insert() の例

<?php 
  $dbconn = pg_connect('dbname=foo');
  // これは少しだけ安全です。なぜなら、全ての値がエスケープされるからです。
  // しかし、PostgreSQL は JSON/Array をサポートしています。これらの型に
  // ついてはエスケープされたクエリや、プリペアドクエリでも安全ではありません。
  $res = pg_insert($dbconn, 'post_log', $_POST, PGSQL_DML_ESCAPE);
  if ($res) {
      echo "POST data is successfully logged\n";
  } else {
      echo "User must have sent wrong inputs\n";
  }
?>

参考

pg_convert() - 連想配列の値を、SQL 文として実行可能な形式に変換する