他のバージョンの文書10 | 9.6 | 9.5 | 9.4 | 9.3 | 9.2 | 9.1 | 9.0 | 8.4 | 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2

9.22. システム情報関数

表9-44に、セッションおよびシステムの情報を抽出する関数を示します。

本節でリストされている関数のほかに、同様にシステム情報を提供する統計システムに関連した数多くの関数があります。

表 9-44. セッション情報関数

名前戻り型説明
current_database()name現在のデータベースの名前
current_schema()name現在のスキーマの名前
current_schemas(boolean)name[]オプションで暗黙的なスキーマも含む、検索パス内のスキーマの名前
current_username現在の実行コンテキストのユーザ名
inet_client_addr()inetリモート接続のアドレス
inet_client_port()intリモート接続のポート
inet_server_addr()inetローカル接続のアドレス
inet_server_port()intローカル接続のポート
pg_my_temp_schema()oidセッションの一時スキーマのOID。もしなければ0
pg_is_other_temp_schema(oid)booleanスキーマが他のセッションの一時スキーマかどうか?
pg_postmaster_start_time()timestamp with time zoneサーバの起動時刻
session_usernameセッションのユーザ名
usernamecurrent_userと等価
version()textPostgreSQLバージョン情報

session_userは、通常、現在のデータベース接続を初期化したユーザです。しかし、スーパユーザはこの設定をSET SESSION AUTHORIZATIONを使用して変更することができます。current_userは、権限の検査に適用されるユーザ識別子です。通常はセッションユーザと同じですが、SET ROLEを使用して変更可能です。SECURITY DEFINER属性を持つ関数の実行中にも変更します。Unix用語で言うと、セッションユーザは"実ユーザ"で、現在のユーザは"実効ユーザ"です。

注意: current_usersession_userおよびuserSQLにおいて特殊な構文上の地位を持っており、括弧を付けずに呼び出さなければなりません。

current_schema関数は、検索パスの先頭にあるスキーマ名(もしくは、検索パスが空の場合はNULL値)を返します。これは、対象スキーマを指定せずに作成された、任意のテーブルまたは他の名前付きオブジェクトに使用されるスキーマです。また、current_schemas(boolean) は、検索パスに存在する全てのスキーマ名の配列を返します。booleanオプションにより、pg_catalogのような暗黙的に含まれているシステムスキーマを、検索パスに含めて返すかどうかを指定します。

注意: 検索パスは、実行時の設定で変更することができます。使用するコマンドは以下の通りです。

SET search_path TO schema [, schema, ...]

inet_client_addrは現在のクライアントのIPアドレスを返し、inet_client_portはそのポート番号を返します。inet_server_addrは、現在の接続を受け付けたサーバのIPアドレスを返し、inet_server_portはそのポート番号を返します。これら全ての関数は接続がUnix-domain socket経由の場合NULLを返します。

pg_my_temp_schemaは、現在のセッションの一時スキーマのOIDを返します。もし(一時テーブルをまったく作成していないために)存在しなければ0を返します。pg_is_other_temp_schemaは、指定したOIDが他のセッションの一時スキーマのOIDであれば、真を返します。(例えば、他のセッションの一時テーブルをカタログ表示から除外したい場合などで有用です。)

pg_postmaster_start_timeはサーバが起動した時のtimestamp with time zoneを返します。

version関数はPostgreSQLサーバのバージョンを記述した文字列を返します。

表9-45に列挙した関数を使用して、ユーザはオブジェクトのアクセス権限をプログラムから問い合わせることができます。権限についての詳細は、項5.6を参照してください。

表 9-45. アクセス権限照会関数

名前戻り型説明
has_database_privilege(user, database, privilege) booleanユーザにデータベースに対する権限があるのか
has_database_privilege(database, privilege) boolean現在のユーザにデータベースに対する権限があるのか
has_function_privilege(user, function, privilege) booleanユーザに関数に対する権限があるのか
has_function_privilege(function, privilege) boolean現在のユーザに関数に対する権限があるのか
has_language_privilege(user, language, privilege) booleanユーザに言語に対する権限があるのか
has_language_privilege(language, privilege) boolean現在のユーザに言語に対する権限があるのか
has_schema_privilege(user, schema, privilege) booleanユーザにスキーマに対する権限があるのか
has_schema_privilege(schema, privilege) boolean現在のユーザにスキーマに対する権限があるのか
has_table_privilege(user, table, privilege) booleanユーザにテーブルに対する権限があるのか
has_table_privilege(table, privilege) boolean現在のユーザにテーブルに対する権限があるのか
has_tablespace_privilege(user, tablespace, privilege) booleanユーザにテーブル空間に対する権限があるのか
has_tablespace_privilege(tablespace, privilege) boolean現愛のユーザにテーブル空間に対する権限があるのか
pg_has_role(user, role, privilege) booleanユーザにロールに対する権限があるのか
pg_has_role(role, privilege) boolean現在のユーザにロールに対する権限があるのか

has_database_privilege関数は、あるユーザが特定の方法でデータベースにアクセス可能かどうかを検査します。この関数での引数の使用方法は、has_table_privilegeに類似しています。対象とするアクセス権限の種類は、CREATECONNECTTEMPORARY、またはTEMPTEMPORARYと同じ)で評価する必要があります。

has_function_privilege関数は、あるユーザが特定の方法で関数にアクセス可能かどうかを検査します。この関数での引数の使用方法は、has_table_privilegeに類似しています。関数をOIDではなくテキスト文字列で指定した場合、regprocedure データ型(項8.16を参照)と同じ入力が可能です。対象とするアクセス権限の種類は、現在EXECUTEで評価する必要があります。以下に例を示します。

SELECT has_function_privilege('joeuser', 'myfunc(int, text)', 'execute');

has_language_privilege関数は、あるユーザが特定の方法で手続き言語にアクセス可能かどうかを検査します。この関数での引数の使用方法は、has_table_privilegeに類似しています。対象とするアクセス権限の種類は、現在USAGEで評価する必要があります

has_schema_privilege関数は、あるユーザが特定の方法でスキーマにアクセス可能かどうかを検査します。この関数での引数の使用方法は、has_table_privilegeに類似しています。対象とするアクセス権限の種類は、CREATEもしくはUSAGEで評価する必要があります。

has_table_privilegeはユーザが特定の方法でテーブルにアクセスできるかどうかを検査します。ユーザは名前でもOID(pg_authid.oid)でも指定することができます。この引数が省略された場合はcurrent_userが使用されます。テーブルは名前またはOIDで指定することができます。(従って、has_table_privilegeには、引数の数や型で区別される6つの種類があることになります。)名前で指定する場合、必要に応じてスキーマで修飾することができます。 求めるアクセス権限はテキスト文字列で指定します。これはSELECTINSERTUPDATEDELETEREFERENCES、またはTRIGGERのいずれかでなければなりません。(しかし大文字小文字は区別されません。)以下に例を示します。

SELECT has_table_privilege('myschema.mytable', 'select');

has_tablespace_privilege関数は、あるユーザが特定の方法でテーブル空間にアクセス可能かどうかを検査します。この関数での引数の使用方法は、has_table_privilegeに類似しています。対象とするアクセス権限の種類は、CREATEで評価する必要があります。

pg_has_roleは、ユーザが特定の方法でロールにアクセスできるかどうかを検査します。取り得る引数についてはhas_table_privilegeと同様です。対象とするアクセス権限の種類は、 MEMBERUSAGEで評価する必要があります。MEMBERは、ロールの直接または間接メンバ資格(つまり、SET ROLEを行う権限)を表します。一方、USAGEは、そのロール権限がSET ROLEをしなkてもすぐに利用できることを表します。

ユーザがその権限のグラントオプションを保持しているかどうかを確認するためには、権限キーワードにWITH GRANT OPTIONを付けてください。例えば、'UPDATE WITH GRANT OPTION'です。

表9-46に、特定のオブジェクトが、現行スキーマの検索パスにおいて可視かどうかを判別する関数を示します。例えば、あるテーブルを含むスキーマが検索パス内に存在し、検索パス内の前方に同じ名前のテーブルがない場合、そのテーブルは可視であると言います。つまり、これは、テーブルが明示的なスキーマ修飾なしで名前によって参照可能であるということです。全ての可視テーブルの名前を列挙するには以下のようにします。

SELECT relname FROM pg_class WHERE pg_table_is_visible(oid);

表 9-46. スキーマ可視性照会関数

名前戻り型説明
pg_conversion_is_visible(conversion_oid) boolean変換が検索パスにおいて可視かどうか
pg_function_is_visible(function_oid) boolean関数が検索パスにおいて可視であるか
pg_operator_is_visible(operator_oid) boolean演算子が検索パスにおいて可視であるか
pg_opclass_is_visible(opclass_oid) boolean演算子クラスが検索パスにおいて可視であるか
pg_table_is_visible(table_oid) booleanテーブルが検索パスにおいて可視かどうか
pg_ts_config_is_visible(config_oid) booleanテキスト検索構成が検索パスにおいて可視かどうか
pg_ts_dict_is_visible(dict_oid) booleanテキスト検索辞書が検索パスにおいて可視かどうか
pg_ts_parser_is_visible(parser_oid) booleanテキスト検索パーサが検索パスにおいて可視かどうか
pg_ts_template_is_visible(template_oid) booleanテキスト検索テンプレートが検索パスにおいて可視かどうか
pg_type_is_visible(type_oid) boolean型(またはドメイン)が検索パスにおいて可視かどうか

それぞれの関数はデータベースオブジェクトの1つの型に対して可視性の検査を行います。pg_table_is_visibleがビュー、インデックス、シーケンスに対しても使用できること、pg_type_is_visibleがドメインに対しても使用できることに注意してください。関数および演算子では、パスの前方に同じ名前かつ同じ引数のデータ型を持つオブジェクトが存在しなければ、検索パス内のオブジェクトは可視です。演算子クラスでは、名前と関連するインデックスアクセスメソッドが考慮されます。

これらの関数は全て、検査するオブジェクトを識別するために、オブジェクトのOIDを必要とします。オブジェクトを名前でテストする場合、OID別名型(regclassregtyperegprocedureregoperatorregconfig、またはregdictionary)を使用すると便利です。例えば、以下のようにします。

SELECT pg_type_is_visible('myschema.widget'::regtype);

ただし、このように修飾されていない名前をテストしても、あまり意味がないことに注意してください。名前が認識されれば、それは必ず可視ということになります。

表9-47に、システムカタログから情報を抽出する関数を列挙します。

表 9-47. システムカタログ情報関数

名前戻り型説明
format_type(type_oid, typemod)textデータ型のSQL名の取得
pg_get_constraintdef(constraint_oid)textget definition of a constraint
pg_get_constraintdef(constraint_oid, pretty_bool)text制約の定義を取得
pg_get_expr(expr_text, relation_oid)text式中のいかなるVarも、2番目のパラメータによって指定されるリレーションを参照すると仮定して、式の内部形式を逆コンパイル
pg_get_expr(expr_text, relation_oid, pretty_bool)text式中のいかなるVarも、2番目のパラメータによって指定されるリレーションを参照すると仮定して、式の内部形式を逆コンパイル
pg_get_indexdef(index_oid)textインデックスに対するCREATE INDEXコマンドの取得
pg_get_indexdef(index_oid, column_no, pretty_bool)textインデックスに対するCREATE INDEXコマンドの取得、またはcolumn_noが非ゼロの場合は、1つのインデックス列のみの定義の取得
pg_get_ruledef(rule_oid)textルールに対するCREATE RULEコマンドを取得
pg_get_ruledef(rule_oid, pretty_bool)textルールに対するCREATE RULEコマンドを取得
pg_get_serial_sequence(table_name, column_name)textserialまたはbigserial列が使用するシーケンス名の取得
pg_get_triggerdef(trigger_oid)textトリガに対するCREATE [ CONSTRAINT ] TRIGGERコマンドの取得
pg_get_userbyid(roleid)name与えられたIDでロール名を取得
pg_get_viewdef(view_name)textビューに対する現在のSELECTコマンドを取得(廃止予定
pg_get_viewdef(view_name, pretty_bool)textビューに対する現在のSELECTコマンドを取得(廃止予定
pg_get_viewdef(view_oid)textビューに対する現在のSELECTコマンドを取得
pg_get_viewdef(view_oid, pretty_bool)textビューに対する現在のSELECTコマンドを取得
pg_tablespace_databases(tablespace_oid)setof oidテーブル空間内にオブジェクトを所有するデータベースOID集合を取得

format_typeは、自身の型OIDと場合により型修飾子によって特定されるデータ型のSQL名を返します。特定の修飾子が既知でなければ型修飾子にNULLを渡します。

pg_get_constraintdefpg_get_indexdefpg_get_ruledef、 および pg_get_triggerdefそれぞれは、対応する制約、インデックス、ルール、もしくはトリガに対するコマンド作成を再構築します。(これはコマンドのオリジナルテキストではなく、逆コンパイルされた再構築であることに注意してください。)pg_get_exprは、列のデフォルト値のような個々の式の内部形式を逆コンパイルします。システムカタログの内容を試験するときに便利です。 pg_get_viewdef はビューを定義するSELECT問い合わせを再構築します。これらの関数のほとんどは2つの異形があり、そのうちの1つはオプションとして結果を"pretty print"(訳注:"見やすく表示")します。pretty printされた書式はより読みやすい半面、デフォルトの書式の方が今後のバージョンのPostgreSQLでも同様に解釈することができそうです。ダンプを目的とする場合は、見やすく表示する出力を使用しないでください。見やすい表示用のパラメータにfalseを渡すことで、このパラメータをまったく持たない種類の結果と同一の結果を生成します

pg_get_serial_sequenceは、列に関連したシーケンスの名前を返します。もし、列に関連したシーケンスが存在しなければ、NULLを返します。最初の入力パラメータはテーブル名です。スキーマを付けることもできます。2番目のパラメータは列名です。最初のパラメータは普通スキーマとテーブルですので、二重引用符付の識別子としては解釈されません。つまり、デフォルトで小文字に変換されます。一方2番目のパラメータは単なる列名であり、二重引用符付として解釈され、その大文字小文字は保持されます。この関数は、シーケンス関数に渡すことができるよう適切な書式で値を返します(項9.15を参照)。この関連付けはALTER SEQUENCE OWNED BYにより変更、削除することができます。(この関数はおそらくpg_get_owned_sequenceから呼び出されるはずです。名前は、serialbigserial列で実際に入力されたものが反映されます。)

pg_get_userbyidはそのOIDで与えられたロールの名前を抽出します。

pg_tablespace_databasesによりテーブル空間の使用状況を確認することができます。これは、そのテーブル空間内に格納されたオブジェクトを持つデータベースのOIDの集合を返します。この関数が何らかの行を返した場合、このテーブル空間は空ではなく、そのため、削除することができませんテーブル空間内に格納された特定のオブジェクトを表示するためには、pg_tablespace_databasesで識別されたデータベースに接続し、そのpg_classカタログに問い合わせを行う必要があります。

表9-48に示される関数は、COMMENTコマンドによって以前に保存されたコメントを抽出します。指定されたパラメータに一致するコメントが検出されない場合、NULL値が返されます。

表 9-48. コメント情報関数

名前戻り型説明
col_description(table_oid, column_number)textテーブル列のコメントを取得
obj_description(object_oid, catalog_name)textデータベースオブジェクトのコメントを取得
obj_description(object_oid)textデータベースオブジェクトのコメントを取得(廃止予定
shobj_description(object_oid, catalog_name)text共有データベースオブジェクトのコメントを取得

col_description()関数は、テーブルのOIDとその列番号で指定されるテーブルの列のコメントを返します。obj_description()関数は、テーブル列自体がOIDを所有していませんので、テーブル列に対して使用することはできません。

obj_description()関数の2つのパラメータを取る形式はそのOIDと保有しているシステムカタログの名前で指定されたデータベースオブジェクトのコメントを返します。例えば、obj_description(123456,'pg_class')はOID 123456を持つテーブルのコメントを抽出します。obj_description()関数の単一パラメータ形式はオブジェクトのOIDのみ必要とします。異なったシステムカタログに渡ってOIDが一意である保証はないことから現在は使われません。ですから、間違ったコメントが返ることがあります。

shobj_descriptionobj_descriptionと同じように使用されますが、共有オブジェクトのコメント取得のために使用されます。一部のシステムカタログは、各クラスタ内のデータベース全体に対して大域的です。これらのコメントも同様に大域的に格納されます。

表9-49で示される関数はサーバ内部トランザクション情報をユーザ水準にエクスポートします。これら関数の主な使用目的は2つのスナップショット間でどちらのトランザクションがコミットされたのかを特定するためです。

表 9-49. トランザクションIDとスナップショット

名前戻り型説明
txid_current()bigint現在のトランザクションIDの取得
txid_current_snapshot()txid_snapshot現在のスナップショットの取得
txid_snapshot_xmin(txid_snapshot)bigintスナップショットのxminの取得
txid_snapshot_xmax(txid_snapshot)bigintスナップショットのxmaxの取得
txid_snapshot_xip(txid_snapshot)setof bigintスナップショットにある進行中のトランザクションIDの取得
txid_visible_in_snapshot(bigint, txid_snapshot)booleanスナップショットにあるトランザクションIDは可視か?

内部トランザクションID型(xid)は32ビット幅あるので40億トランザクション毎ラップします。しかし、これら関数はインストレーションの生涯にわたってラップしないよう、"epoch"カウンタにより拡張される64ビット形式にエクスポートします。

表 9-50. スナップショット構成要素

名前説明
xmin いまだ使用中の最古のトランザクションID(txid)
xmax 最初のまだ割り当てられていないtxid。これ以降の全てのtxidはスナップショットの時点で未開始。従って不可視。
xip_list スナップショット時の使用中のtxid。これら全てはxminxmax間に存在。xmin <= txid < xmaxであり、このリストにないtxidはスナップショット時、既に完了されているので、そのコミット状態によって可視であるか終わっているかのいずれか。

txid_snapshotのテキスト表現はxmin:xmax:xip_list。例えば、10:20:10,14,15xmin=10, xmax=20, xip_list=10, 14, 15を指す。