Home > PHP > Function > PostgreSQL > pg_get_notify()

pg_get_notify()

pg_get_notify - Gets SQL NOTIFY message

Syntax

array pg_get_notify (resource $connection, int $result_type)

Arguments

  • connection - PostgreSQL database connection resource.
  • result_type - An optional parameter that controls how the returned array is indexed. result_type is a constant and can take the following values: PGSQL_ASSOC, PGSQL_NUM and PGSQL_BOTH. Using PGSQL_NUM, pg_get_notify() will return an array with numerical indices, using PGSQL_ASSOC it will return only associative indices while PGSQL_BOTH, the default, will return both numerical and associative indices.

Description

pg_get_notify() gets notifications generated by a NOTIFYSQL command. To receive notifications, the LISTENSQL command must be issued.

Version

PHP 4.3.0, 5

Return value

An array containing the NOTIFYmessage name and backend PID. Otherwise if no NOTIFYis waiting, then FALSE is returned.