pg_get_notify

PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
pg_get_notify - Gets SQL NOTIFY message
Manual
Code Examples

pg_get_notify( PgSql\Connection$connection, [int$mode = PGSQL_ASSOC] ): array|false

pg_get_notify gets notifications generated by a NOTIFY SQL command. To receive notifications, the LISTEN SQL command must be issued.

Parameters

connection

An PgSql\Connection instance.

mode

An optional parameter that controls how the returned array is indexed. mode 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.

Return Values

An array containing the NOTIFY message name and backend PID. If supported by the server, the array also contains the server version and the payload. Otherwise if no NOTIFY is waiting, then false is returned.

Changelog

Version Description
8.1.0 The connection parameter expects an PgSql\Connection instance now; previously, a resource was expected.

Related Functions

Example of pg_get_notify

Show all examples for pg_get_notify

PHP Version:


Function pg_get_notify:

PostgreSQL Functions

Most used PHP functions