Home/ Manual/ pgsql / functions/ pg_field_num

pg_field_num

PHP function Edit on GitHub ✎

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

Returns the field number of the named field

Description

pg_field_num(PgSql\Result $result, string $field): int

pg_field_num() will return the number of the field number that corresponds to the field in the given result instance.

Note

This function used to be called pg_fieldnum().

Parameters

result: Result
field: The name of the field. The given name is treated like an identifier in an SQL command, that is, it is downcased unless double-quoted.

Return Values

The field number (numbered from 0), or -1 on error.

Changelog

Version	Description

Examples

Getting information about fields

php

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

  $res = pg_query($dbconn, "select author, year, title from authors where author = 'Orwell'");
  
  echo "Column 'title' is field number: ", pg_field_num($res, 'title');
?>

The above example will output:

output

Column 'title' is field number: 2