phpday 2025 - Call For Papers

PostgreSQL 関数

注意

注意:

すべての関数がすべての構築環境でサポートされるわけではありません。 サポートされる関数は、使用する libpq(PostgreSQL の C クライアント ライブラリ)のバージョンと libpq のコンパイル方法に依存します。 もし PHP の PostgreSQL 拡張モジュールに足りない関数がある場合、 原因は libpq がその関数をサポートしていないことです。

注意:

ほとんどの PostgreSQL 関数は、オプションの第 1 引数として connection を受け付けます。もしこれを 指定しなかった場合、直近にオープンされた接続を使用します。 そのような接続が存在しなかった場合、関数は false を返します。

注意:

PostgreSQL は、オブジェクトの生成時やクエリの実行時に 識別子(例: テーブル名・カラム名)を自動的に小文字に変換します。 この自動変換を防ぐには、識別子をダブルクォート("")でエスケープする 必要があります。

注意:

PostgreSQL には、データベースのスキーマ情報(例: データベース内の すべてのテーブルなど)を取得するための特別なコマンドがありません。 その代わりに、PostgreSQL 7.4 以降では information_schema という標準スキーマが存在し、必要な情報が検索しやすい形式で格納されています。 詳しい情報は » PostgreSQL Documentation を参照ください。

目次

  • pg_affected_rows — 変更されたレコード(タプル)の数を返す
  • pg_cancel_query — 非同期クエリを取り消す
  • pg_client_encoding — クライアントのエンコーディングを取得する
  • pg_close — PostgreSQL 接続をクローズする
  • pg_connect — PostgreSQL 接続をオープンする
  • pg_connect_poll — 進行中の非同期接続のステータスをポーリングする
  • pg_connection_busy — 接続がビジーかどうか調べる
  • pg_connection_reset — 接続をリセット(再接続)する
  • pg_connection_status — 接続ステータスを取得する
  • pg_consume_input — 接続の入力を読み取る
  • pg_convert — 連想配列の値を、SQL 文として実行可能な形式に変換する
  • pg_copy_from — 配列からテーブルに挿入する
  • pg_copy_to — 配列にテーブルをコピーする
  • pg_dbname — データベース名を取得する
  • pg_delete — レコードを削除する
  • pg_end_copy — PostgreSQL バックエンドと同期する
  • pg_escape_bytea — bytea フィールドに挿入するために文字列をエスケープする
  • pg_escape_identifier — テキスト型フィールドに挿入するために、識別子をエスケープする
  • pg_escape_literal — テキスト型フィールドに挿入するために、リテラルをエスケープする
  • pg_escape_string — クエリに使う文字列をエスケープする
  • pg_execute — 指定したパラメータを用いてプリペアドステートメントを実行するリクエストを 送信し、その結果を待つ
  • pg_fetch_all — 取得されたすべての行を配列として取得する
  • pg_fetch_all_columns — 指定したカラムの全ての行を配列として取得する
  • pg_fetch_array — 行を配列として取得する
  • pg_fetch_assoc — 行を連想配列として取得する
  • pg_fetch_object — 行をオブジェクトとして得る
  • pg_fetch_result — 結果インスタンスから値を返す
  • pg_fetch_row — 数値添字の配列として行を得る
  • pg_field_is_null — フィールドが SQL の NULL かどうか調べる
  • pg_field_name — フィールドの名前を返す
  • pg_field_num — 指定されたフィールドのフィールド番号を返す
  • pg_field_prtlen — 表示される長さを返す
  • pg_field_size — 指定したフィールドの内部記憶領域におけるサイズを返す
  • pg_field_table — tables フィールドの名前あるいは oid を返す
  • pg_field_type — フィールド番号に対応する型名を返す
  • pg_field_type_oid — フィールド番号に対応する型 ID(OID)を返す
  • pg_flush — 送信を待っているクエリデータをフラッシュする
  • pg_free_result — クエリ結果のメモリを開放する
  • pg_get_notify — SQL NOTIFY メッセージを取得する
  • pg_get_pid — バックエンドのプロセス ID を得る
  • pg_get_result — 非同期クエリの結果を取得する
  • pg_host — 接続に関連するホスト名を返す
  • pg_insert — テーブルに配列を挿入する
  • pg_last_error — 特定の接続から直近のエラーメッセージ文字列を取得する
  • pg_last_notice — PostgreSQL サーバーからの直近の通知メッセージを返す
  • pg_last_oid — 直近の行のオブジェクト ID を返す
  • pg_lo_close — ラージオブジェクトをクローズする
  • pg_lo_create — ラージオブジェクトを生成する
  • pg_lo_export — ラージオブジェクトをファイルにエクスポートする
  • pg_lo_import — ファイルからラージオブジェクトをインポートする
  • pg_lo_open — ラージオブジェクトをオープンする
  • pg_lo_read — ラージオブジェクトを読み込む
  • pg_lo_read_all — ラージオブジェクト全体を読み込みブラウザに直接送信する
  • pg_lo_seek — ラージオブジェクトの位置をシークする
  • pg_lo_tell — ラージオブジェクトのカレントのシーク位置を返す
  • pg_lo_truncate — ラージオブジェクトを切り詰める
  • pg_lo_unlink — ラージオブジェクトを削除する
  • pg_lo_write — ラージオブジェクトに書き込む
  • pg_meta_data — テーブルからメタデータを取得する
  • pg_num_fields — フィールド数を返す
  • pg_num_rows — 行数を返す
  • pg_options — 接続に関連するオプションを取得する
  • pg_parameter_status — サーバーのパラメータ設定を検索する
  • pg_pconnect — 持続的な PostgreSQL 接続をオープンする
  • pg_ping — データベース接続を調べる
  • pg_port — 接続に関連するポート番号を返す
  • pg_prepare — 指定したパラメータでプリペアドステートメントを作成するリクエストを サーバーに送信し、その完了を待つ
  • pg_put_line — NULL で終わる文字列を PostgreSQL バックエンドに送信する
  • pg_query — クエリを実行する
  • pg_query_params — SQL コマンドとパラメータを分割してサーバーへ送信し、その結果を待つ
  • pg_result_error — 結果に関連するエラーメッセージを取得する
  • pg_result_error_field — エラー報告の各フィールドを返す
  • pg_result_memory_size — クエリーの結果に割り当てられたメモリ使用量を返します
  • pg_result_seek — 結果インスタンスの内部行オフセットを設定する
  • pg_result_status — クエリ結果のステータスを取得する
  • pg_select — レコードを選択する
  • pg_send_execute — 指定したパラメータでプリペアドステートメントを実行するリクエストを 送信し、その結果を待たない
  • pg_send_prepare — 指定したパラメータでプリペアドステートメントを作成するリクエストを 送信し、その結果を待たない
  • pg_send_query — 非同期クエリを送信する
  • pg_send_query_params — コマンドとパラメータを分割してサーバーに送信し、その結果を待たない
  • pg_set_chunked_rows_size — Set the query results to be retrieved in chunk mode
  • pg_set_client_encoding — クライアントのエンコーディングを設定する
  • pg_set_error_context_visibility — pg_last_error が返すコンテクストのエラーメッセージのアクセス権を設定する
  • pg_set_error_verbosity — pg_last_error および pg_result_error が返すメッセージの詳細度を指定する
  • pg_socket — PostgreSQL 接続の下層にある、読み取り専用のソケットのハンドルを取得する
  • pg_trace — PostgreSQL 接続のトレースを有効にする
  • pg_transaction_status — サーバー上で実行中のトランザクションの状態を返す
  • pg_tty — 接続に関する TTY 名を返す
  • pg_unescape_bytea — bytea 型のバイナリをアンエスケープする
  • pg_untrace — PostgreSQL 接続のトレースを無効にする
  • pg_update — テーブルを更新する
  • pg_version — クライアント・プロトコル・サーバーのバージョンを配列で返す
add a note

User Contributed Notes 17 notes

up
7
Tony Murray
12 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
20 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
19 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
20 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
23 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
19 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
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
-1
Anonymous
18 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
22 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
19 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
-2
adaml at mimuw edu pl
20 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
23 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
23 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
passion at monkey dot org
23 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
-3
Chris KL
19 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;
}
To Top