pg_delete
(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
pg_delete — レコードを削除する
説明
PgSql\Connection
$connection
,string
$table_name
,array
$conditions
,int
$flags
= PGSQL_DML_EXEC
): string|bool
pg_delete() は、conditions
で指定したキーと値を用いてテーブルからレコードを削除します。
flags
が指定された場合、指定したオプションを
つけて pg_convert() が conditions
に適用されます。
デフォルトでは、
pg_delete() は生の値を渡します。
値はエスケープするか、
PGSQL_DML_ESCAPE
オプションを指定しなければいけません。
PGSQL_DML_ESCAPE
はパラメータや識別子をクォートし、
エスケープします。
よって、テーブル/カラム名は大文字小文字を区別します。
エスケープやプリペアドクエリであっても、 LIKE, JSON, Array, Regex などのクエリを守れない可能性があることに注意してください。 これらのパラメータはコンテクストに応じて処理されるべきです。 たとえば、値をエスケープ/検証する処理を行うことなどです。
パラメータ
connection
-
PgSql\Connection クラスのインスタンス。
table_name
-
行を削除するテーブルの名前。
conditions
-
そのキーが
table_name
テーブルのフィールド名、 値が削除したいフィールドの値となっている配列。 flags
-
PGSQL_CONV_FORCE_NULL
、PGSQL_DML_NO_CONV
、PGSQL_DML_ESCAPE
、PGSQL_DML_EXEC
、PGSQL_DML_ASYNC
あるいはPGSQL_DML_STRING
を組み合わせた数。flags
にPGSQL_DML_STRING
が含まれている場合、クエリ文字列が返されます。PGSQL_DML_NO_CONV
あるいはPGSQL_DML_ESCAPE
が設定されている場合は、内部的に pg_convert() を呼びません。
戻り値
成功した場合に true
を、失敗した場合に false
を返します。
flags
で PGSQL_DML_STRING
が渡された場合は文字列を返します。
変更履歴
バージョン | 説明 |
---|---|
8.1.0 |
connection は、PgSql\Connection クラスのインスタンスを期待するようになりました。
これより前のバージョンでは、リソース を期待していました。
|
例
例1 pg_delete() の例
<?php
$db = pg_connect('dbname=foo');
// これは少しだけ安全です。なぜなら、全ての値がエスケープされるからです。
// しかし、PostgreSQL は JSON/Array をサポートしています。これらの型に
// ついてはエスケープされたクエリや、プリペアドクエリでも安全ではありません。
$res = pg_delete($db, 'post_log', $_POST, PG_DML_ESCAPE);
if ($res) {
echo "POST data is deleted: $res\n";
} else {
echo "User must have sent wrong inputs\n";
}
?>