Php/docs/function.pg-delete

• PHP Manual
• PostgreSQL Functions
• Deletes records

pg_delete

(PHP 4 >= 4.3.0, PHP 5, PHP 7)

pg_delete — Deletes records

Description

pg_delete ( resource $connection , string $table_name , array $assoc_array [, int $options = PGSQL_DML_EXEC ] ) : mixed

pg_delete() deletes records from a table specified by the keys and values in assoc_array. If options is specified, pg_convert() is applied to assoc_array with the specified options.

If options is specified, pg_convert() is applied to assoc_array with the specified flags.

By default pg_delete() passes raw values. Values must be escaped or PGSQL_DML_ESCAPE option must be specified. PGSQL_DML_ESCAPE quotes and escapes parameters/identifiers. Therefore, table/column names became case sensitive.

Note that neither escape nor prepared query can protect LIKE query, JSON, Array, Regex, etc. These parameters should be handled according to their contexts. i.e. Escape/validate values.

Parameters

connection

PostgreSQL database connection resource.

table_name

Name of the table from which to delete rows.

assoc_array

An array whose keys are field names in the table table_name, and whose values are the values of those fields that are to be deleted.

options

Any number of PGSQL_CONV_FORCE_NULL, PGSQL_DML_NO_CONV, PGSQL_DML_ESCAPE, PGSQL_DML_EXEC, PGSQL_DML_ASYNC or PGSQL_DML_STRING combined. If PGSQL_DML_STRING is part of the options then query string is returned. When PGSQL_DML_NO_CONV or PGSQL_DML_ESCAPE is set, it does not call pg_convert() internally.

Return Values

Returns TRUE on success or FALSE on failure. Returns string if PGSQL_DML_STRING is passed via options.

Examples

Example #1 pg_delete() example

<?php   $db = pg_connect('dbname=foo');  // This is safe somewhat, since all values are escaped.  // However PostgreSQL supports JSON/Array. These are not  // safe by neither escape nor prepared query.  $res = pg_delete($db, 'post_log', $_POST);  if ($res) {      echo "POST data is deleted: $res\n";  } else {      echo "User must have sent wrong inputs\n";  }?>

Changelog

Version	Description
5.6.0	No longer experimental. Added PGSQL_DML_ESCAPE constant, TRUE/FALSE and NULL data type support.
5.5.3/5.4.19	Direct SQL injection to table_name and Indirect SQL injection to identifiers are fixed.

See Also

• pg_convert() - Convert associative array values into forms suitable for SQL statements