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

pg_field_table

PHP function Edit on GitHub ✎

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

Returns the name or oid of the tables field

Description

pg_field_table(PgSql\Result $result, int $field, bool $oid_only = false): string|int|false

pg_field_table() returns the name of the table that field belongs to, or the table's oid if oid_only is true.

Parameters

result

Result

field

Field number, starting from 0.

oid_only

By default the tables name that field belongs to is returned but if oid_only is set to true, then the oid will instead be returned.

Return Values

On success either the fields table name or oid, Falseforfailure.

Changelog

VersionDescription

Examples

Getting table information about a field

php
<?php
$dbconn = pg_connect("dbname=publisher") or die("Could not connect");

$res = pg_query($dbconn, "SELECT bar FROM foo");

echo pg_field_table($res, 0);
echo pg_field_table($res, 0, true);

$res = pg_query($dbconn, "SELECT version()");
var_dump(pg_field_table($res, 0));
?>

The above example will output something similar to:

output
foo
14379580

bool(false)

Notes

Note

Returning the oid is much faster than returning the table name because fetching the table name requires a query to the database system table.

See Also

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