php8.5
Home/ Manual/ pgsql / functions/ pg_tty

pg_tty

PHP function Edit on GitHub ✎

(PHP 4, PHP 5, PHP 7, PHP 8)

Return the TTY name associated with the connection

Description

pg_tty(PgSql\Connection|null $connection = null): string

pg_tty() returns the TTY name that server side debugging output is sent to on the given PostgreSQL connection instance.

Note

pg_tty() is obsolete, since the server no longer pays attention to the TTY setting, but the function remains for backwards compatibility.

Parameters

connection

Connection-with-nullable-default

Return Values

A string containing the debug TTY of the connection.

Changelog

VersionDescription
8.0.0connection is now nullable.

Examples

pg_tty() example

php
<?php
$pgsql_conn = pg_connect("dbname=mark host=localhost");

if ($pgsql_conn) {
   print "Server debug TTY is: " . pg_tty($pgsql_conn) . "<br/>\n";
} else {
   print pg_last_error($pgsql_conn);
   exit;
}
?>

Source: reference/pgsql/functions/pg-tty.xml · from the official PHP manual (php/doc-en)