Home/ Manual/ pgsql / functions/ pg_escape_identifier

pg_escape_identifier

PHP function Edit on GitHub ✎

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

Escape an identifier for insertion into a text field

Description

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

pg_escape_identifier() escapes an identifier (e.g. table, field names) for querying the database. It returns an escaped identifier string for PostgreSQL server. pg_escape_identifier() adds double quotes before and after data. Users should not add double quotes. Use of this function is recommended for identifier parameters in query. For SQL literals (i.e. parameters except bytea), pg_escape_literal() or pg_escape_string() must be used. For bytea type fields, pg_escape_bytea() must be used instead.

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_identifier() example

php

<?php 
  // Connect to the database
  $dbconn = pg_connect('dbname=foo');
  
  // Escape the table name data
  $escaped = pg_escape_identifier($table_name);
  
  // Select rows from $table_name
  pg_query("SELECT * FROM {$escaped};");
?>