PHP: PostgreSQL 関数 - Manual
PHP  
downloads | documentation | faq | getting help | mailing lists | | php.net sites | links | my php.net 
search for in the  
<posix_unamepg_affected_rows>
view the version of this page
Last updated: Tue, 21 Dec 2004

XCIII. PostgreSQL 関数

導入

PostgreSQLデータベースはオープンソースのプロダクツであり、無料で 使用可能できます。Postgresは元々UCB(カリフォルニア大学バークレイ校) コンピュータ・サイエンス学部で開発されたものです。このPostgresは、 現在、いくつかの商用データベースにおいてサポートされつつあるオブジェク トリレーショナルデータベース的概念の多くの先駆けでした。 Postgresは、SQL92/SQL3言語サポート、トランザクションインテグリティ、 拡張可能な型を提供しています。PostgreSQLは、Postgresのオリジナルの バークレイ・コードのオープンソースの子孫にあたります。

要件

PostgreSQLサポートを使用するには、PostgreSQL 6.5以降が必要です。 PostgreSQL 7.0以降ではPostgreSQLモジュールの全ての機能を使用可能 です。PostgreSQLは、マルチバイト文字エンコーディングを含む多くの 文字エンコーディングをサポートしています。現在のバージョン及び PostgreSQLに関するより詳細な情報は、 と で入手可能です。

インストール手順

PostgreSQLサポートを利用可能とするには、PHPコンパイル時に --with-pgsql[=DIR] を指定することが必要です。 共有オブジェクトモジュールが利用可能な場合、php.iniextension ディレクティブ または dl() 関数によりPostgreSQLモジュール をロードすることが可能です。

実行用の設定

これらの関数の動作は、php.iniの設定により変化します。

表 1. PostgreSQL設定オプション

名前デフォルト変更の可否
pgsql.allow_persistent"1"PHP_INI_SYSTEM
pgsql.max_persistent"-1"PHP_INI_SYSTEM
pgsql.max_links"-1"PHP_INI_SYSTEM
pgsql.auto_reset_persistent"0"PHP_INI_SYSTEM
pgsql.ignore_notice"0"PHP_INI_ALL
pgsql.log_notice"0"PHP_INI_ALL
PHP_INI_* 定数の詳細と定義については、 ini_set()を参照して下さい。

以下に設定ディレクティブの簡単な説明を示します。

pgsql.allow_persistent boolean

持続的なPostgres接続を可能にするかどうか。

pgsql.max_persistent integer

プロセス毎の持続的Postgres接続の最大数。

pgsql.max_links integer

持続的接続を含むプロセス毎のPostgres接続の最大数。

使用法およびヒント

警告

通知メッセージを処理するコードにバグがあるため、PHP 4.0.6で PostgreSQLモジュールを使用することは推奨されません。 4.1.0以降を使用してください。

警告

PostgreSQLモジュールの関数名は、現在のコーディング標準に準拠する ために 4.2.0以降変更されます。新しい関数名の多くには、 pg_lo_open()のようにアンダースコアが付きます。 いくつかの関数は、pg_exec()からpg_query()というように、統一を とるために関数名が変更されます。 古い名前も4.2.0とそれに続くいくつかのバージョンで使用可能ですが、 将来的には削除される可能性があります。

表 2. 変更された関数名

古い関数名新しい関数名
pg_exec()pg_query()
pg_getlastoid()pg_last_oid()
pg_cmdtuples()pg_affected_rows()
pg_numrows()pg_num_rows()
pg_numfields()pg_num_fields()
pg_fieldname()pg_field_name()
pg_fieldsize()pg_field_size()
pg_fieldnum()pg_field_num()
pg_fieldprtlen()pg_field_prtlen()
pg_fieldisnull()pg_field_is_null()
pg_freeresult()pg_free_result()
pg_result()pg_fetch_result()
pg_loreadall()pg_lo_read_all()
pg_locreate()pg_lo_create()
pg_lounlink()pg_lo_unlink()
pg_loopen()pg_lo_open()
pg_loclose()pg_lo_close()
pg_loread()pg_lo_read()
pg_lowrite()pg_lo_write()
pg_loimport()pg_lo_import()
pg_loexport()pg_lo_export()

従来のpg_connect()()/pg_pconnect()() 構文は、将来的に非同期接続 機能をサポートするために過去のものとなる可能性があります。 pg_connect()pg_pconnect() では、接続文字列を使用してください。

全ての関数が全ての構築環境でサポートされるわけではありません。サ ポートされる関数は、使用するlibpq(PostgreSQLのCクライアントインター フェイス)のバージョンとlibpqのコンパイル方法に依存します。足りな い関数がある場合、libpqはその関数を必要とする機能をサポートしませ ん。

接続するPostgreSQLサーバーよりも新しいlibpqを使用することも重要で す。使用するlibpqのバージョンがPostgreSQLサーバが期待するよりも古 い場合、問題を生じる可能性があります。

バージョン6.3(1998/3/2)以降、PostgreSQLはUNIXドメインソケットを 使用しています。これらの新しいコネクションの使用例を以下に示す表に 示します。このソケットは/tmp/.s.PGSQL.5432に あります。このオプションはpostmasterに対して'- i'フラグを指定することで有効となります。これは "Unixドメインソケッ ト以外のTCP/IPソケットもlisten する"という意味です。

表 3. postmasterとPHP

postmasterPHPステータス
postmaster &pg_connect("dbname=MyDbName");OK
postmaster -i &pg_connect("dbname=MyDbName");OK
postmaster &pg_connect("host=localhost dbname=MyDbName"); Unable to connect to PostgreSQL server: connectDB() failed: Is the postmaster running and accepting TCP/IP (with -i) connection at 'localhost' on port '5432'? in /path/to/file.php3 on line 20.
postmaster -i &pg_connect("host=localhost dbname=MyDbName");OK

PostgreSQL サーバへの接続は、以下のようにコマンド文字列の中に 値の組を羅列することにより、確立することができます。 $conn = pg_Connect("host=myHost port=myPort tty=myTTY options=myOptions dbname=myDB user=myUser password=myPassword");

以前の構文: $conn = pg_connect ("host", "port", "options", "tty", "dbname") は古い構文であり、推奨されません。

環境変数は、PostgreSQLサーバ/クライアントの動作に影響を与えます。 例えば、PostgreSQLモジュールは、ホスト名が接続文字列で省略された場 合、環境変数PGHOSTを探します。サポートされる環境変数は、バージョン 毎に異なります。詳細は、PostgreSQLプログラマ用マニュアル(libpq - 環境変数)を参照下さい。

適切なユーザ用に環境変数が設定されていることを確認して下さい。 カレントのプロセスで利用可能な環境変数を確認するには、 $_ENV または getenv() を使用して下さい。

例 1. デフォルトのパラメータを設定する

PGHOST=pgsql.example.com
PGPORT=7890
PGDATABASE=web-system
PGUSER=web-user
PGPASSWORD=secret
PGDATESTYLE=ISO
PGTZ=JST
PGCLIENTENCODING=EUC-JP

export PGHOST PGPORT PGDATABASE PGUSER PGPASSWORD PGDATESTYLE PGTZ PGCLIENTENCODING

定義済みの定数

これらの定数は、この拡張モジュールで定義されており、 この拡張モジュールがPHP内部にコンパイルされているか実行時に動的にロー ドされるかのどちらかの場合のみ使用可能です。

PGSQL_ASSOC (integer)

PGSQL_NUM (integer)

PGSQL_BOTH (integer)

PGSQL_CONNECTION_BAD (integer)

PGSQL_CONNECTION_OK (integer)

PGSQL_SEEK_SET (integer)

PGSQL_SEEK_CUR (integer)

PGSQL_SEEK_END (integer)

PGSQL_ESCAPE_STRING (integer)

PGSQL_ESCAPE_BYTEA (integer)

PGSQL_EMPTY_QUERY (integer)

PGSQL_COMMAND_OK (integer)

PGSQL_TUPLES_OK (integer)

PGSQL_COPY_OUT (integer)

PGSQL_COPY_IN (integer)

PGSQL_BAD_RESPONSE (integer)

PGSQL_NONFATAL_ERROR (integer)

PGSQL_FATAL_ERROR (integer)

PostgreSQL 7.1.0から、textデータ型の最大サイズは1GBとなっています。 古いPostgreSQLのtextデータ型はブロックサイズ(デフォルトは8KB、最大 32KBをコンパイル時に定義可能)の制限を受けていました。

ラージオブジェクト(lo)インターフェースを使用するには、そのクエリーを トランザクション・ブロックの中に入れてやる必要があります。 トランザクション・ブロックはBEGINで始まり、 そのトランザクションが有効な場合はCOMMITまたは ENDで終わります。トランザクションが失敗した場合、 そのトランザクションはROLLBACKまたは ABORTにより閉じる必要があります。

例 2. ラージオブジェクトの使用例

<?php
   $database
= pg_connect ("dbname=jacarta");
  
pg_exec ($database, "begin");
  
$oid = pg_locreate ($database);
   echo (
"$oid\n");
  
$handle = pg_loopen ($database, $oid, "w");
   echo (
"$handle\n");
  
pg_lowrite ($handle, "large object data");
  
pg_loclose ($handle);
  
pg_exec ($database, "commit");
?>
ラージオブジェクトリソースを閉じる前にPostgreSQLサーバへの接続を 閉じないようにして下さい。

目次
pg_affected_rows -- 変更されたレコード(タプル)の数を返す
pg_cancel_query --  非同期クエリを取り消す
pg_client_encoding --  PostgreSQLクライアントのエンコーディングを取得する
pg_close -- PostgreSQL接続を閉じる
pg_connect -- PostgreSQL接続を開く
pg_connection_busy --  接続がビジーかどうか調べる
pg_connection_reset --  接続をリセット(再接続)する
pg_connection_status --  接続ステータスを取得する
pg_convert --  SQL命令として実行可能な形式の連想配列の値に変換する
pg_copy_from --  配列からテーブルをコピーする
pg_copy_to --  配列にテーブルをコピーする
pg_dbname -- データベース名の取得
pg_delete --  レコードを削除する
pg_end_copy -- PostgreSQLバックエンドに同期する
pg_escape_bytea --  bytea型にバイナリをエスケープする
pg_escape_string --  テキスト/文字型用の文字列をエスケープする
pg_fetch_all -- 取得されたすべての行を配列として取得
pg_fetch_array -- 行を配列として取得する
pg_fetch_assoc -- 行を配列として取得する
pg_fetch_object -- 行をオブジェクトとして得る
pg_fetch_result -- 結果リソースから値を返す
pg_fetch_row -- 数字をインデックスとする配列として行を得る
pg_field_is_null -- フィールドがNULLかどうか調べる
pg_field_name -- フィールドの名前を返す
pg_field_num -- 指定されたフィールドのフィールド番号を返す
pg_field_prtlen -- 表示される長さを返す
pg_field_size --  指定したフィールドの内部記憶領域におけるサイズを返す
pg_field_type --  フィールド番号に対応する型名を返す
pg_free_result -- メモリを開放する
pg_get_notify -- データベース接続にpingを行う
pg_get_pid -- データベース接続にpingを行う
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_all --  ラージオブジェクト全体を読み込みブラウザに直接送信する
pg_lo_read -- ラージオブジェクトを読み込む
pg_lo_seek --  ラージオブジェクトの位置をシークする
pg_lo_tell --  ラージオブジェクトのカレントの位置を返す
pg_lo_unlink -- ラージオブジェクトを削除する
pg_lo_write -- ラージオブジェクトを書く
pg_meta_data --  テーブルからメタデータを取得する
pg_num_fields -- フィールド数を返す
pg_num_rows -- 行数を返す
pg_options -- 接続に関連するオプションを取得する
pg_parameter_status --  Returns the value of a server parameter
pg_pconnect -- 持続的なデータベース接続をオープンする
pg_ping -- データベース接続を調べる
pg_port -- 接続に関連するポート番号を返す
pg_put_line --  NULLで終る文字列をPostgreSQLバックエンドに送信する
pg_query -- クエリを実行する
pg_result_error --  結果に関連するエラーメッセージを取得する
pg_result_seek -- 結果リソースの内部レコード(行)オフセットを設定する
pg_result_status --  クエリ結果のステータスを取得する
pg_select --  レコードを選択する
pg_send_query --  非同期クエリを送信する
pg_set_client_encoding --  PostgreSQLクライアントのエンコーディングを設定する
pg_trace -- PostgreSQLサーバーへの接続をトレースする
pg_tty -- tty名を返す
pg_unescape_bytea --  bytea型のバイナリをアンエスケープする
pg_untrace --  PostgreSQLサーバーへの接続のトレースを無効にする
pg_update --  テーブルを更新する
pg_version --  Returns an array with client, protocol and server version (when available)


add a note add a note User Contributed Notes
PostgreSQL 関数
adaml at mimuw edu pl
02-Oct-2004 01:07
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");
raja shahed at christine nothdurfter dot com
16-Jul-2004 06:14
A very good tutorial for Windows users' is here Herr Johan Faxer Shows also how to install Cygwin.
74012 dot 2773 at compuserve dot com
02-Jul-2004 04:35
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);
}
abondi at ijk dot it
26-May-2004 12:11
I've found another function to mimic the following mysql list tables function () 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));
}
fmonteiro11 at hotmail dot com
15-Jan-2004 06:50
Another good source of knowledge is
daniel at bichara dot com dot br
31-Dec-2002 01:04
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.
anonymous at unknown dot com
29-Nov-2002 05:50
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
swm at php dot net
22-Aug-2002 03:49
My talk on PHP and PostgreSQL which I presented at O'Reilly OSCON 2002 is now online.

mystran at wasteland dot pp dot htv dot fi
04-Feb-2002 03:46
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.
saberit at home dot com
15-Sep-2001 09:11
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'.
hubert at hubertmuller dot com
09-Jul-2001 11:36
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).
passion at monkey dot org
28-Jun-2001 01:53
I've tried to mimic the following mysql database connection functions for postgres.



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));
}
!spamcraig at ahdore dot com
15-Apr-2001 08:11
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.
jdb30 at cornell.edu
06-Dec-2000 08:08
For further reading on PostgreSQL, see:
bleach at chek dot com
02-Mar-2000 08:36
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.

<posix_unamepg_affected_rows>
 Last updated: Tue, 21 Dec 2004
show source | credits | sitemap | contact | advertising | mirror sites 
Copyright © 2001-2005 The PHP Group
All rights reserved.
This unofficial mirror is operated at: /
Last updated: Mon Mar 14 08:13:06 2005 Local time zone must be set--see zic manual page