Home/ Manual/ pgsql / functions/ pg_escape_literal

pg_escape_literal

PHP function Edit on GitHub ✎

(PHP 5 >= 5.4.4, PHP 7, PHP 8)

Escape a literal for insertion into a text field

Description

pg_escape_literal([PgSql\Connection $connection], string $string): string|false

pg_escape_literal() escapes a literal for querying the PostgreSQL database. It returns an escaped literal in the PostgreSQL format. pg_escape_literal() adds quotes before and after data. Users should not add quotes. Use of this function is recommended instead of pg_escape_string(). If the type of the column is bytea, pg_escape_bytea() must be used instead. For escaping identifiers (e.g. table, field names), pg_escape_identifier() must be used.

Parameters

connection: Connection-with-unspecified-default
string: A string containing text to be escaped.

Return Values

A string containing the escaped data, or false on failure.

Changelog

Version	Description

Examples

pg_escape_literal() example

php

<?php 
  // Connect to the database
  $dbconn = pg_connect('dbname=foo');
  
  // Read in a text file (containing apostrophes and backslashes)
  $data = file_get_contents('letter.txt');
  
  // Escape the text data
  $escaped = pg_escape_literal($data);
  
  // Insert it into the database. Note that no quotes around {$escaped}
  pg_query("INSERT INTO correspondence (name, data) VALUES ('My letter', {$escaped})");
?>