pg_field_type

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

pg_field_type Returns the type name for the corresponding field number

Description

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

pg_field_type() returns a string containing the base type name of the given field in the given result instance.

Note:

If the field uses a PostgreSQL domain (rather than a basic type), it is the name of the domain's underlying type that is returned, rather than the name of the domain itself.

Note:

This function used to be called pg_fieldtype().

Parameters

result

An PgSql\Result instance, returned by pg_query(), pg_query_params() or pg_execute()(among others).

field

Field number, starting from 0.

Return Values

A string containing the base name of the field's type.

Changelog

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

Examples

Example #1 Getting information about fields

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

// Assume 'title' is a varchar type
$res = pg_query($dbconn, "select title from authors where author = 'Orwell'");

echo
"Title field type: ", pg_field_type($res, 0);
?>

The above example will output:

Title field type: varchar

See Also

add a note add a note

User Contributed Notes 4 notes

up
3
Joshua Burns
11 years ago
Here is an updated list of nearly every PostgreSQL data type, and PHP's internal C-type equivalent, updated for PostgreSQL 9.2. The first array maps PHP's internal data type to PostgreSQL's equivalents. The second maps PostgreSQL's data-types to PHP's equivalents.

<?php

$php_to_pg
= array(
   
'bit' => array('bit'),
   
'bool' => array('boolean'),
   
'box' => array('box'),
   
'bpchar' => array('character','char'),
   
'bytea' => array('bytea'),
   
'cidr' => array('cidr'),
   
'circle' => array('circle'),
   
'date' => array('date'),
   
'daterange' => array('daterange'),
   
'float4' => array('real'),
   
'float8' => array('double precision'),
   
'inet' => array('inet'),
   
'int2' => array('smallint', 'smallserial'),
   
'int4' => array('integer', 'serial'),
   
'int4range' => array('int4range'),
   
'int8' => array('bigint', 'bigserial'),
   
'int8range' => array('int8range'),
   
'interval' => array('interval'),
   
'json' => array('json'),
   
'lseg' => array('lseg'),
   
'macaddr' => array('macaddr'),
   
'money' => array('money'),
   
'numeric' => array('decimal', 'numeric'),
   
'numrange' => array('numrange'),
   
'path' => array('path'),
   
'point' => array('point'),
   
'polygon' => array('polygon'),
   
'text' => array('text'),
   
'time' => array('time', 'time without time zone'),
   
'timestamp' => array('timestamp', 'timestamp without time zone'),
   
'timestamptz' => array('timestamp with time zone'),
   
'timetz' => array('time with time zone'),
   
'tsquery' => array('tsquery'),
   
'tsrange' => array('tsrange'),
   
'tsvector' => array('tsvector'),
   
'uuid' => array('uuid'),
   
'varbit' => array('bit varying'),
   
'varchar' => array('character varying', 'varchar'),
   
'xml' => array('xml'),
);

$pg_to_php = array(
   
'bit' => 'bit',
   
'boolean' => 'bool',
   
'box' => 'box',
   
'character' => 'bpchar',
   
'char' => 'bpchar',
   
'bytea' => 'bytea',
   
'cidr' => 'cidr',
   
'circle' => 'circle',
   
'date' => 'date',
   
'daterange' => 'daterange',
   
'real' => 'float4',
   
'double precision' => 'float8',
   
'inet' => 'inet',
   
'smallint' => 'int2',
   
'smallserial' => 'int2',
   
'integer' => 'int4',
   
'serial' => 'int4',
   
'int4range' => 'int4range',
   
'bigint' => 'int8',
   
'bigserial' => 'int8',
   
'int8range' => 'int8range',
   
'interval' => 'interval',
   
'json' => 'json',
   
'lseg' => 'lseg',
   
'macaddr' => 'macaddr',
   
'money' => 'money',
   
'decimal' => 'numeric',
   
'numeric' => 'numeric',
   
'numrange' => 'numrange',
   
'path' => 'path',
   
'point' => 'point',
   
'polygon' => 'polygon',
   
'text' => 'text',
   
'time' => 'time',
   
'time without time zone' => 'time',
   
'timestamp' => 'timestamp',
   
'timestamp without time zone' => 'timestamp',
   
'timestamp with time zone' => 'timestamptz',
   
'time with time zone' => 'timetz',
   
'tsquery' => 'tsquery',
   
'tsrange' => 'tsrange',
   
'tstzrange' => 'tstzrange',
   
'tsvector' => 'tsvector',
   
'uuid' => 'uuid',
   
'bit varying' => 'varbit',
   
'character varying' => 'varchar',
   
'varchar' => 'varchar',
   
'xml' => 'xml'
);

?>
up
0
Anonymous
14 years ago
Also be aware that postgreSQL array fields will prefix the type name with an underscore (e.g. "_int4" or "_text"), while composite a.k.a. row-type fields will return type "record".
up
-1
marxarelli
18 years ago
Because complete documentation is always helpful, here are all the PostgreSQL general purpose types as they are listed in the 8.1 documentation, and each corresponding string returned by pg_field_type().

bigint => int8
bigserial => int8
bit => bit
bit varying => varbit
boolean => bool
box => box
bytea => bytea
character varying => varchar
character => bpchar
cidr => cidr
circle => circle
date => date
double precision => float8
inet => inet
integer => int4
interval => interval
line => line
lseg => lseg
macaddr => macaddr
money => money
numeric => numeric
path => path
point => point
polygon => polygon
real => float4
smallint => int2
serial => int4
text => text
time => time
time with time zone => timetz
timestamp => timestamp
timestamp with time zone => timestamptz

And for the record... (note the 7.4 client lib)
# postmaster --version
postmaster (PostgreSQL) 8.0.4

# ldd libphp4.so
...
libpq.so.3 => /usr/lib/libpq.so.3 (0xb7ac8000)
...
up
-1
andy at a 2 h d dot com
20 years ago
The types returned are:
  bool
  int2 (smallint)
  int4
  int8 (bigint)
  numeric
  float4 (real / float)
  float8 (double)
  timestamp
  date
  time
  varchar
  bpchar (fixed leng string, 'blank padded char')
  inet (ip address)
  money

There are some other more esoteric types, e.g. 'circle', but these are the most common.
To Top