PHP 8.3.4 Released!

PostgreSQL-Funktionen

Anmerkungen

Hinweis:

Nicht alle Funktionen sind in allen Versionen verfügbar. Es hängt davon ab, welche libpq-Version (die PostgreSQL-C-Client-Bibliothek) auf Ihrem Rechner verfügbar ist und wie libpq kompiliert wurde. Falls eine Funktion nicht verfügbar ist, liegt es daran, dass libpq die nötigen Routinen nicht unterstützt, die diese Funktion braucht.

Hinweis:

Die meisten PostgreSQL-Funktionen nehmen den Parameter connection als optionalen ersten Parameter entgegen. Falls er nicht angegeben wurde, wird die zuletzt geöffnete Verbindung benutzt. Wenn keine geöffnete Verbindung existiert, geben die Funktionen false zurück.

Hinweis:

PostgreSQL wandelt automatisch alle Bezeichner (beispielsweise Tabellen- oder Spaltennamen) in Kleinbuchstaben um, und zwar sowohl bei der Erzeugung der Objekte als auch in Abfragen. Um Namen in Groß- und Kleinschreibung oder in Großbuchstaben zu erzwingen, müssen diese in doppelte Anführungszeichen ("") eingeschlossen werden.

Hinweis:

PostgreSQL stellt keine speziellen Kommandos zur Verfügung, um Informationen über ein Datenbank-Schema (z. B. alle Tabellen in der aktuellen Datenbank) zu erhalten. Stattdessen gibt es ab der Version 7.4 und höher ein Standard-Schema, das information_schema, in dem alle notwendigen Informationen in System-Views enthalten und die einfach abzufragen sind. Ausführliche Informationen darüber gibt es in der » PostgreSQL-Dokumentation.

Inhaltsverzeichnis

  • pg_affected_rows — Gibt die Anzahl betroffener Datensätze (Tupel) zurück
  • pg_cancel_query — Löscht eine asynchrone Abfrage
  • pg_client_encoding — Liefert die Kodierung des Clients
  • pg_close — Schließt eine PostgreSQL-Verbindung
  • pg_connect_poll — Poll the status of an in-progress asynchronous PostgreSQL connection attempt
  • pg_connect — Öffnet eine PostgreSQL-Verbindung
  • pg_connection_busy — Gibt den Status der Verbindung zurück (busy/not busy)
  • pg_connection_reset — Setzt die Verbindung zurück und verbindet neu
  • pg_connection_status — Gibt den Verbindungsstatus zurück
  • pg_consume_input — Reads input on the connection
  • pg_convert — Konvertiert die Werte eines assoziativen Arrays in die für SQL-Anweisungen passende Form
  • pg_copy_from — Fügt Datensätze aus einem Array in eine Tabelle ein
  • pg_copy_to — Kopiert eine Tabelle in ein Array
  • pg_dbname — Liefert den Namen der Datenbank
  • pg_delete — Löscht Datensätze
  • pg_end_copy — Synchronisation mit dem PostgreSQL-Server
  • pg_escape_bytea — Maskiert Zeichenketten zum Einfügen in ein Feld vom Typ bytea
  • pg_escape_identifier — Escape a identifier for insertion into a text field
  • pg_escape_literal — Escape a literal for insertion into a text field
  • pg_escape_string — Maskiert einen String für Abfragen
  • pg_execute — Fordert den Datenankserver auf, eine vorbereitete Anfrage mit den angegebenen Parametern auszuführen und wartet auf das Ergebnis
  • pg_fetch_all_columns — Gibt alle Werte einer bestimmten Spalte eines Abfrageergebnisses in einem Array zurück
  • pg_fetch_all — Liefert alle Zeilen eines Abfrageergebnisses als Array
  • pg_fetch_array — Liefert eine Zeile als Array
  • pg_fetch_assoc — Liefert eine Zeile als assoziatives Array
  • pg_fetch_object — Liefert einen Datensatz als Objekt
  • pg_fetch_result — Liefert Werte aus einer Ergebnisinstanz
  • pg_fetch_row — Liefert einen Datensatz als numerisches Array
  • pg_field_is_null — Prüft, ob ein Feld einen SQL-NULL-Wert enthält
  • pg_field_name — Liefert den Namen eines Feldes
  • pg_field_num — Liefert die Feldnummer des angegebenen Feldes
  • pg_field_prtlen — Liefert die Länge des Feldes
  • pg_field_size — Liefert die interne Größe des belegten Speichers für ein Feld
  • pg_field_table — Gibt zu einem Feldnamen den Namen der Tabelle oder deren oid zurück, in der das Feld definiert ist
  • pg_field_type_oid — Liefert die ID des PostgreSQL-Datentyps (OID) eines Feldes
  • pg_field_type — Liefert den Datentyp eines Feldes
  • pg_flush — Flush outbound query data on the connection
  • pg_free_result — Gibt den durch Ergebnisse belegten Speicher frei
  • pg_get_notify — Liefert eine SQL-NOTIFY-Nachricht
  • pg_get_pid — Prüft die Datenbankverbindung
  • pg_get_result — Liefert asynchrone Abfrageergebnisse
  • pg_host — Liefert den Namen des Host, zu dem verbunden wurde
  • pg_insert — Überträgt Werte aus einem Array in eine Tabelle
  • pg_last_error — Liefert die letzte Fehlermeldung einer Verbindung
  • pg_last_notice — Liefert die letzte NOTICE-Meldung des PostgreSQL-Servers
  • pg_last_oid — Liefert den Objektbezeichner (OID) des zuletzt eingefügten Datensatzes
  • pg_lo_close — Schließt ein Large Object
  • pg_lo_create — Erzeugt ein Large Object
  • pg_lo_export — Exportiert ein Large Object in eine Datei
  • pg_lo_import — Importiert ein Large Object aus einer Datei
  • pg_lo_open — Öffnet ein Large Object
  • pg_lo_read_all — Liest ein ganzes Large Object und reicht es direkt an den Browser weiter
  • pg_lo_read — Liest ein Large Object
  • pg_lo_seek — Setzt die Lese- oder Schreibposition in einem Large Object
  • pg_lo_tell — Liefert die aktuelle Lese- oder Schreibposition in einem Large Object
  • pg_lo_truncate — Truncates a large object
  • pg_lo_unlink — Löscht ein Large Object
  • pg_lo_write — Schreibt in ein Large Object
  • pg_meta_data — Liefert die Metadaten einer Tabelle als Array
  • pg_num_fields — Gibt die Anzahl der Felder in einem Abfrageergebnis zurück
  • pg_num_rows — Gibt die Anzahl der Zeilen in einem Abfrageergebnis zurück
  • pg_options — Liefert die Verbindungsoptionen der aktuellen Verbindung
  • pg_parameter_status — Liefert den aktuellen Wert eines Parameters des Servers
  • pg_pconnect — Öffnet eine persistente PostgreSQL-Verbindung
  • pg_ping — Prüft die Datenbankverbindung
  • pg_port — Liefert die Portnummer, über die die Verbindung aufgebaut wurde
  • pg_prepare — Sendet eine Aufforderung an den Server, eine vorbereitete Anfrage mit den übergebenen Parametern zu erzeugen und wartet auf ihre Beendigung
  • pg_put_line — Sendet eine NULL-terminierte Zeichenkette zum PostgreSQL-Server
  • pg_query_params — Sendet ein Kommando zum Server und wartet seine Ausführung ab. Getrennt vom SQL-Kommando können dabei Parameter übergeben werden
  • pg_query — Führt eine Abfrage aus
  • pg_result_error_field — Liefert den Inhalt eines bestimmtes Feldes zu einer Fehlermeldung
  • pg_result_error — Liefert die mit der Ergebniskennung verknüpfte Fehlermeldung
  • pg_result_seek — Setzt den internen Datensatzzeiger auf die angegebene Position in einem Abfrageergebnis
  • pg_result_status — Liefert den Status eines Abfrageergebnisses
  • pg_select — Wählt Datensätze aus
  • pg_send_execute — Sendet eine Aufforderung an den Server, eine vorbereitete Abfrage mit den übergebenen Parametern auszuführen, ohne auf die Ergebnisse zu warten
  • pg_send_prepare — Sendet eine Aufforderung an den Server, eine vorbereitete Abfrage mit den übergebenen Parametern zu erzeugen, ohne auf ihre Beendigung zu warten
  • pg_send_query_params — Sendet ein Kommando und separate Parameter zum Server, ohne auf die Rückgabe der Ergebnisse zu warten
  • pg_send_query — Sendet eine asynchrone Abfrage
  • pg_set_client_encoding — Setzt die Kodierung des Clients
  • pg_set_error_context_visibility — Determines the visibility of the context's error messages returned by pg_last_error and pg_result_error
  • pg_set_error_verbosity — Bestimmt den Detaillierungsgrad von Fehlermeldungen, die von pg_last_error und pg_result_error zurückgegeben werden
  • pg_socket — Get a read only handle to the socket underlying a PostgreSQL connection
  • pg_trace — Ermöglicht die Ablaufverfolgung einer Verbindung
  • pg_transaction_status — Gibt den aktuellen Transaktionsstatus des Servers zurück
  • pg_tty — Liefert den TTY-Namen für die Verbindung
  • pg_unescape_bytea — Entfernt Maskierungen für den Typ bytea
  • pg_untrace — Beendet die Ablaufverfolgung einer PostgreSQL-Verbindung
  • pg_update — Aktualisiert eine Tabelle
  • pg_version — Liefert ein Array, das die Versionen von Client, Protokoll und Server enthält (falls verfügbar).
add a note

User Contributed Notes 18 notes

up
8
Tony Murray
11 years ago
A simple conversion for 1D PostgreSQL array data:

// =====
//Example #1 (An array of IP addresses):
<?php
$pgsqlArr
= '{192.168.1.1,10.1.1.1}';

preg_match('/^{(.*)}$/', $pgsqlArr, $matches);
$phpArr = str_getcsv($matches[1]);

print_r($phpArr);
}
// Output:
// Array
// (
// [0] => 192.168.1.1
// [1] => 10.1.1.1
// )
// =====

// =====
// Example #2 (An array of strings including spaces and commas):
<?php
$pgsqlArr
= '{string1,string2,"string,3","string 4"}';

preg_match('/^{(.*)}$/', $pgsqlArr, $matches);
$phpArr = str_getcsv($matches[1]);

print_r($phpArr);
}
// Output:
// Array
// (
// [0] => string1
// [1] => string2
// [2] => string,3
// [3] => string 4
// )
// =====
up
3
abondi at ijk dot it
19 years ago
I've found another function to mimic the following mysql list tables function (http://www.php.net/manual/en/function.mysql-list-tables.php) that's more useful for my target:

function pg_list_tables() {
$sql = "SELECT a.relname AS Name
FROM pg_class a, pg_user b
WHERE ( relkind = 'r') and relname !~ '^pg_' AND relname !~ '^sql_'
AND relname !~ '^xin[vx][0-9]+' AND b.usesysid = a.relowner
AND NOT (EXISTS (SELECT viewname FROM pg_views WHERE viewname=a.relname));";
return(pg_query($conn, $sql));
}
up
0
1413 at blargh dot com
18 years ago
Here is some quick and dirty code to convert Postgres-returned arrays into PHP arrays. There's probably a billion bugs, but since I'm only dealing with variable-depth-and-length arrays of integers, it works for my needs.

Most notably, any data that might have commas in it won't work right...

<?php
function PGArrayToPHPArray($pgArray)
{
$ret = array();
$stack = array(&$ret);
$pgArray = substr($pgArray, 1, -1);
$pgElements = explode(",", $pgArray);

ArrayDump($pgElements);

foreach(
$pgElements as $elem)
{
if(
substr($elem,-1) == "}")
{
$elem = substr($elem,0,-1);
$newSub = array();
while(
substr($elem,0,1) != "{")
{
$newSub[] = $elem;
$elem = array_pop($ret);
}
$newSub[] = substr($elem,1);
$ret[] = array_reverse($newSub);
}
else
$ret[] = $elem;
}
return
$ret;
}
?>
up
0
74012 dot 2773 at compuserve dot com
19 years ago
for just a list of tables, this works with postgresql-7.2.1:

function pg_list_tables($db) {
$sql = "select relname from pg_stat_user_tables order by relname;";
return pg_query($db, $sql);
}
up
0
daniel at bichara dot com dot br
21 years ago
Running RedHat Linux and Apache with suexec enabled you must include pgsql.so on each .php file using dl("pgsql.so") and remove "extension=pgsql.so" from php.ini, otherwise Apache (httpd) will not start.
up
0
saberit at home dot com
22 years ago
I tried compiling PHP from source with PostgreSQL support (./configure --with-pgsql=/usr/local/pgsql) and ran into a bunch of problems when trying to 'make'. The problem was that some of the PostgreSQL headers were not installed by default when I installed PostgreSQL from source. When installing PostgreSQL make sure you 'make install-all-headers' after you 'make install'.
up
-1
WillowCatkin at hotmail dot com
18 years ago
There is an example:
<?php
/*
* Define PostgreSQL database server connect parameters.
*/
define('PGHOST','10.0.0.218');
define('PGPORT',5432);
define('PGDATABASE','example');
define('PGUSER', 'root');
define('PGPASSWORD', 'nopass');
define('PGCLIENTENCODING','UNICODE');
define('ERROR_ON_CONNECT_FAILED','Sorry, can not connect the database server now!');

/*
* Merge connect string and connect db server with default parameters.
*/
pg_pconnect('host=' . PGHOST . ' port=' . PGPORT . ' dbname=' . PGDATABASE . ' user=' . PGUSER . ' password=' . PGPASSWORD);

/*
* generate sql statements to call db-server-side stored procedure(or function)
* @parameter string $proc stored procedure name.
* @parameter array $paras parameters, 2 dimensions array.
* @return string $sql = 'select "proc"(para1,para2,para3);'
* @example pg_prepare('userExists',
* array(
* array('userName','chin','string'),
* array('userId','7777','numeric')
* )
* )
*/
function pg_prepare($proc, $paras)
{
$sql = 'select "' . $proc . '"(';
$sql .= $paras[0][2] == 'numeric' ? $paras[0][1] : "'" . str_replace("'","''",$paras[0][1]) . "'";
$len = count($paras);
for (
$i = 1; $i < $len; $i ++)
{
$sql .= ',';
$sql .= $paras[$i][2] == 'numeric' ? $paras[$i][1] : "'" . str_replace("'","''",$paras[$i][1]) . "'";
}
$sql .= ');';
return
$sql;
}
?>
up
-1
Anonymous
17 years ago
Lots of advice on stored procedures didn't work for me. This did:

<?php
$response
= pg_query( $connection, "BEGIN; DECLARE s CURSOR FOR SELECT get_consumer('harry'); FETCH ALL IN s; END;" );
?>

..where harry looks like this:

CREATE OR REPLACE FUNCTION get_consumer( varchar )
RETURNS refcursor
AS '
DECLARE
_name ALIAS FOR $1;
r refcursor;
BEGIN
OPEN r FOR SELECT name FROM consumer
WHERE
consumer.name = _name
;
RETURN r;
END
' LANGUAGE 'plpgsql';
up
-2
anonymous at unknown dot com
21 years ago
I just wanted to add to my previous post I've got the system up and running.
Environment: Windows XP, Apache 1.3.23, Php 4.3 RC2, PostGreSQL beta4 native windows build

Installation was fairly easy:
1. read the readme.txt
2. edit the setenv.bat as described in readme
3. run 'initdb'
all execs are in /bin
help is accessed like <command> --help
4. Start the psql deamon - you may want to create a batch file like
'D:\postgres_beta4\bin\postmaster -h localhost -D D:/postgres_beta4/data'

--deamon should be up and running now--

You can login into a shell from a console like
'psql -h localhost -d <username>'

You must load the postgresql extension by editing the php.ini and restarting apache in order to access psql with php.

And one final not: when running
$dbconn = pg_connect ("host=localhost port=5432 dbname=$dbname user=$user");
remember that $user and or $dbname is CASESENSITIVE.

Oh yeah, I created the data dir manually - don't know whether that was necessary

Grtz Vargo
up
-2
anis_wn at gawab dot com
18 years ago
Setting up PostgreSQL for higher security PHP connection.

Case:
We want to connect to PostgreSQL database using username and password supplied by webuser at login time.

Fact (Linux):
Apache (perhaps other servers, too) running the server as (default to) apache user account. So if you connect to PostgreSQL using default user, apache will be assingned for it. If you hard code the user and password in your PHP script, you'll loose security restriction from PostgreSQL.

Solution:
(You are assumed to have enough privilege to do these things, though)
1. Edit pg_hba.conf to have the line like the one below
host db_Name [web_server_ip_address] [ip_address_mask] md5
2. Add to you script the login page that submits username and password.
3. Use those information to login to PostgreSQL like these...
<?
$conn = "host=$DBHost port=$DBPort dbname=$DBName ".
"user='{$_POST['dbUsername']}' password='{$_POST['dbPassword']}'";
$db = pg_connect ($conn);
[your other codes go here...]
?>
4. You must add users in PostgreSQL properly.
5. For your convenience, you can store the username and password to $_SESSION variable.

Good luck.
Anis WN
up
-3
mystran at wasteland dot pp dot htv dot fi
22 years ago
Nice to know fact that I didn't find documented here.

PHP will return values of PostgreSQL boolean datatype as single character strings "t" and "f", not PHP true and false.

[Editor's Note]
't' or 'f' is valid boolean expression for PostgreSQL.

All values from PostgreSQL are strings, since PostgreSQL integer, float may be much larger than PHP's native int, double can handle. PostgreSQL array is not supported.
up
-3
passion at monkey dot org
22 years ago
I've tried to mimic the following mysql database connection functions for postgres.
http://www.php.net/manual/en/function.mysql-list-dbs.php
http://www.php.net/manual/en/function.mysql-list-tables.php

These are assuming that you're passing in $link as the result from pg_connect:

function pg_list_dbs($link)
{
$sql = 'SELECT datname FROM pg_database';
return (pg_query($link, $sql));
}

function pg_list_tables($link)
{
$sql = "SELECT relname FROM pg_class WHERE relname !~ '^pg_'";
return (pg_query($link, $sql));
}
up
-2
adaml at mimuw edu pl
19 years ago
Yes, PHP does support stored procedures
You have to add "select" before the name of the
procedure, just like that:

$result = pg_querry($conn, "SELECT procedure_x($aa)");

if a procedure returns a cursor you do something like that:

$result = pg_query($conn, "SELECT procedure_x('rcursor'); FETCH ALL IN rcursor");
up
-2
hubert at hubertmuller dot com
22 years ago
The best way to find the separated list of tables, sequences, keys etc is:

SELECT relname FROM pg_class WHERE relkind='<value>' AND relname !~ '^pg_';

<value> takes:
i for keys,
r for relations,
S for sequences

Note that all tables names that begins with 'pg_' are PostgreSQL internal tables (this explain why I use AND relname !~ '^pg_' condition).
up
-2
!spamcraig at ahdore dot com
22 years ago
If you want to extract data from select statements, you need to store the result index, and then apply pg_result to that value. Basically, do this

$resultIdx = pg_query ($database, "select * from tablename");
$mySelect = pg_fetch_result($resultIdx, 0, 0); // gets column 0 of tuple 0
echo("My select: [".$mySelect."]");

I'm new to php and had to do some fiddling around to work this out. It's reasonably elementary, but not demonstrated by the examples on these pages. Hopefully it will come in useful to someone else.
up
-2
bleach at chek dot com
24 years ago
If you want to see all the objects in a database, you can find that information in the pg_class table. <BR>
SELECT * FROM pg_class;<BR>
Now this is going to be kind of long and complex, to see how psql command handles the \d and other things. use the syntax. psql -E <Database>, ie psql -E mydatabase <BR>
What this will do is show the SQL command used for everything. So when you type a \d or something, it shows the SQL query used for the result.
up
-3
Chris KL
18 years ago
Here is a better array parser for PHP. It will work with 1-d arrays only. Unlike the example below it will work in all cases.

/**
* Change a db array into a PHP array
* @param $arr String representing the DB array
* @return A PHP array
*/
function phpArray($dbarr) {
// Take off the first and last characters (the braces)
$arr = substr($dbarr, 1, strlen($dbarr) - 2);

// Pick out array entries by carefully parsing. This is necessary in order
// to cope with double quotes and commas, etc.
$elements = array();
$i = $j = 0;
$in_quotes = false;
while ($i < strlen($arr)) {
// If current char is a double quote and it's not escaped, then
// enter quoted bit
$char = substr($arr, $i, 1);
if ($char == '"' && ($i == 0 || substr($arr, $i - 1, 1) != '\\'))
$in_quotes = !$in_quotes;
elseif ($char == ',' && !$in_quotes) {
// Add text so far to the array
$elements[] = substr($arr, $j, $i - $j);
$j = $i + 1;
}
$i++;
}
// Add final text to the array
$elements[] = substr($arr, $j);

// Do one further loop over the elements array to remote double quoting
// and escaping of double quotes and backslashes
for ($i = 0; $i < sizeof($elements); $i++) {
$v = $elements[$i];
if (strpos($v, '"') === 0) {
$v = substr($v, 1, strlen($v) - 2);
$v = str_replace('\\"', '"', $v);
$v = str_replace('\\\\', '\\', $v);
$elements[$i] = $v;
}
}

return $elements;
}
up
-11
Anonymous
17 years ago
Chris KL: Will parse well {"\\"}? The second " will be treat as escaped while it shoudn't...
To Top