他のバージョンの文書 15 | 14 | 13 | 12 | 11 | 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.25. システム情報関数

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

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

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

名前戻り型説明
current_catalogname(SQL標準で"カタログ"と呼ばれる)現在のデータベースの名前
current_database()name現在のデータベースの名前
current_query()textクライアントから提示された、現在実行中問い合わせのテキスト(複数の文を含むことあり)
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_backend_pid()int 現在のセッションに結びついたサーバプロセスのプロセスID
pg_conf_load_time()timestamp with time zone設定を読み込んだ時刻
pg_is_other_temp_schema(oid)booleanスキーマが他のセッションの一時スキーマかどうか?
pg_listening_channels()setof text今のセッションにおいて現在LISTEN中のチャンネル名
pg_my_temp_schema()oidセッションの一時スキーマのOID。もしなければ0
pg_postmaster_start_time()timestamp with time zoneサーバの起動時刻
pg_trigger_depth()intPostgreSQLのトリガの現在の入れ子の深さ (直接もしくは間接的に、トリガ内部から呼ばれていなければ0を返す)
session_usernameセッションのユーザ名
usernamecurrent_userと等価
version()textPostgreSQLバージョン情報

注意: current_catalogcurrent_schemacurrent_usersession_userおよびuserSQLにおいて特殊な構文上の地位を持っており、最後に括弧を付けずに呼び出さなければなりません。(PostgreSQLではcurrent_schemaの場合括弧を使用することができますが、他は使えません。)

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

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

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

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

pg_listening_channelsは、現在のセッションでLISTEN中のチャンネル名のセットを返します。詳細はLISTENを参照して下さい。

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

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

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

pg_conf_load_timeはサーバの設定ファイルが最後に読み込まれた時のtimestamp with time zoneを返します。 (現在のセッションがその時点で稼働していた場合、これはセッション自体が設定ファイルを読み込んだ時刻となります。 このためこの読み取った結果は多少他のセッションと異なります。 この他の場合は、postmasterプロセスが設定ファイルを再読み込みした時刻となります。)

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

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

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

名前戻り型説明
has_any_column_privilege(user, table, privilege) booleanユーザがテーブルのどの列に対しても権限を所有しているか
has_any_column_privilege(table, privilege) boolean現在のユーザがテーブルのどの列に対しても権限を所有しているか
has_column_privilege(user, table, column, privilege) booleanユーザに列に対する権限があるか
has_column_privilege(table, column, privilege) boolean現在のユーザに列に対する権限があるか
has_database_privilege(user, database, privilege) booleanユーザにデータベースに対する権限があるのか
has_database_privilege(database, privilege) boolean現在のユーザにデータベースに対する権限があるのか
has_foreign_data_wrapper_privilege(user, fdw, privilege) booleanユーザに外部データラッパに対する権限があるのか
has_foreign_data_wrapper_privilege(fdw, 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_sequence_privilege(user, sequence, privilege) booleanユーザにシーケンスに対する権限があるのか
has_sequence_privilege(sequence, privilege) boolean現在のユーザにシーケンスに対する権限があるのか
has_server_privilege(user, server, privilege) booleanユーザに外部サーバに対する権限があるのか
has_server_privilege(server, 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_table_privilegeはあるユーザが特定の方法でテーブルにアクセス可能かどうかを検査します。ユーザは名前、OID(pg_authid.oid)、もしくは擬似的なPUBLICロールを意味するpublicで指定できます。省略された場合はcurrent_userが使われます。テーブルは名前もしくはOIDで指定可能です。(従って、実際にはhas_table_privilegeの6つの変形があり、引数の数と型で区別されます。)名前を指定する場合、必要であればスキーマ権限で指定できます。目的とするアクセス権限の型はテキスト文字列で指定され、それは、SELECTINSERTUPDATE, DELETE, TRUNCATE, REFERENCES、またはTRIGGERの内の1つで評価されます。オプションとして、権限がGRANTオプションにより付与されているかどうかの権限の検査するため、WITH GRANT OPTIONを付加することができます。更に、複数の権限型はコンマで分割してたリスト可能です。この場合、結果はリストされた権限の1つでも存在すればとなります。(権限文字列が有効でない場合、追加の空白を権限名の中を除き、間に挿入できます。)例を示します。

SELECT has_table_privilege('myschema.mytable', 'select');
SELECT has_table_privilege('joe', 'mytable', 'INSERT, SELECT WITH GRANT OPTION');

has_sequence_privilegeはあるユーザが特定の方法でシーケンスにアクセス可能かどうかを検査します。可能な引数はhas_table_privilegeに対するものと類似しています。USAGESELECTまたはUPDATEの内のいずれかにより目的とする権限型が評価されます。

has_any_column_privilegeはあるユーザが特定の方法でテーブルのどんな列にもアクセス可能かどうかを検査します。 可能な引数はhas_table_privilegeに対するものと類似していますが、SELECTINSERTUPDATE、またはREFERENCESのいくつかの組み合わせで目的とする権限型が評価される点を除きます。テーブル階層におけるこれらの権限を所有することは、テーブルのそれぞれの列に対し暗黙的にそれら権限を与えることに注意してください。従って、同一の引数に対してhas_table_privilegeを返す場合、has_any_column_privilegeは常にを返します。しかし、少なくとも一つの列に対し権限の列階層許可があれば、has_any_column_privilegeも成功します。

has_column_privilegeはあるユーザが特定の方法でテーブルのある列にもアクセス可能かどうかを検査します。 可能な引数は、列が追加的に名前または属性番号のいずれかで指定される点を加えれば、has_table_privilegeと類似しています。目的と知るアクセス権限型は、SELECTINSERTUPDATE、またはREFERENCESのいくつかの組み合わせで評価されなければなりません。テーブル階層におけるこれらの権限を所有することは、テーブルのそれぞれの列に対し暗黙的にそれら権限を与えることに注意してください。

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

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

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

has_foreign_data_wrapper_privilege関数は、あるユーザが特定の方法で外部データラッパーにアクセス可能かどうかを検査します。 引数として取り得るものはhas_table_privilegeと同じです。対象とするアクセス権限の種類はUSAGEで評価する必要があります。

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

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

has_server_privilegeはユーザが特定の方法で外部サーバにアクセスできるかどうかを検査します。 可能な引数はhas_table_privilegeに類似しています。対象とするアクセス権限はUSAGEで評価する必要があります。

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

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

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

SELECT relname FROM pg_class WHERE pg_table_is_visible(oid);

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

名前戻り型説明
pg_collation_is_visible(collation_oid) boolean照合順序が検索パスにおいて可視かどうか
pg_conversion_is_visible(conversion_oid) boolean変換が検索パスにおいて可視かどうか
pg_function_is_visible(function_oid) boolean関数が検索パスにおいて可視であるか
pg_opclass_is_visible(opclass_oid) boolean演算子クラスが検索パスにおいて可視であるか
pg_operator_is_visible(operator_oid) boolean演算子が検索パスにおいて可視であるか
pg_opfamily_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-54に、システムカタログから情報を抽出する関数を列挙します。

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

名前戻り型説明
format_type(type_oid, typemod)textデータ型のSQL名の取得
pg_describe_object(catalog_id, object_id, object_sub_id)textデータベースオブジェクトの説明の取得
pg_identify_object(catalog_id oid, object_id oid, object_sub_id integer)type text, schema text, name text, identity textデータベースオブジェクトの識別を取得
pg_get_constraintdef(constraint_oid)text制約の定義を取得
pg_get_constraintdef(constraint_oid, pretty_bool)text制約の定義を取得
pg_get_expr(pg_node_tree, relation_oid)text式中のいかなるVarも、2番目のパラメータによって指定されるリレーションを参照すると仮定して、式の内部形式を逆コンパイル
pg_get_expr(pg_node_tree, relation_oid, pretty_bool)text式中のいかなるVarも、2番目のパラメータによって指定されるリレーションを参照すると仮定して、式の内部形式を逆コンパイル
pg_get_functiondef(func_oid)text関数定義の取得
pg_get_function_arguments(func_oid)text関数定義(デフォルト値付き)の引数リストを取得
pg_get_function_identity_arguments(func_oid)text関数(デフォルト値の付いていない)特定の引数リストを取得
pg_get_function_result(func_oid)text関数に対するRETURNS句の取得
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_keywords()setof recordSQLキーワードとそれらの種類のリストを取得
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)textserialsmallserial、またはbigserial列が使用するシーケンス名の取得
pg_get_triggerdef(trigger_oid)textトリガに対するCREATE [ CONSTRAINT ] TRIGGERコマンドの取得
pg_get_triggerdef(trigger_oid, pretty_bool)textトリガに対するCREATE [ CONSTRAINT ] TRIGGERコマンドの取得
pg_get_userbyid(role_oid)name与えられたOIDでロール名を取得
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_get_viewdef(view_oid, wrap_column_int)textビューまたはマテリアライズドビューの元になるSELECTコマンドを取得。 フィールドを含む行は指定された列数で折り返され、成形された表示が行われます。
pg_options_to_table(reloptions)setof record格納オプションの名前/値のペアのセットを取得
pg_tablespace_databases(tablespace_oid)setof oidテーブル空間内にオブジェクトを所有するデータベースOID集合を取得
pg_tablespace_location(tablespace_oid)text指定したテーブル空間が実際に配置されているファイルシステム上のパスを取得
pg_typeof(any)regtype指定した値のデータ型を取得
collation for (any)text引数の照合順序を取得

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

関数pg_get_keywordsは、サーバが認識したSQLキーワードを記述するレコード一式を返します。word列にはキーワードが含まれます。catcode列は種類コードを含みます。それらは、予約されていないを表わすU、列名のC、関数名型のT、または予約語であることのR、のいずれかです。catdesc列は種類を記述する現地語化された可能性のある文字列を含みます。

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

pg_get_functiondefは、ある関数のCREATE OR REPLACE FUNCTION文全てを返します。pg_get_function_argumentsは、CREATE FUNCTIONの中に出現しなければならない形式で、引数リストを返します。pg_get_function_resultは同様、その関数の適切なRETURNS句を返します。pg_get_function_identity_argumentsは、インスタンスに対し、ALTER FUNCTIONの中に出現しなければならない形式で、ある関数を特定するのに必要な引数リストを返します。この形式はデフォルト値を省略します。

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

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

pg_options_to_tablepg_class.reloptionspg_attribute.attoptionsへ格納オプションが設定されている場合に そのペア(option_name/option_value)を返します。

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

pg_describe_objectはカタログOID、オブジェクトOID、もしくは(おそらく0の)サブオブジェクトOIDで指定されたデータベースオブジェクトのテキストによる説明を返します。 この説明はサーバの設定に依存しますが、人が読んでわかる、そして翻訳も可能になることを目的としたのもです。 これはpg_dependカタログに格納されたオブジェクトの識別判断の際に有用です。

pg_identify_objectはたログOID, オブジェクトOID、そして(ゼロである可能性を有する)サブオブジェクトIDにより指定されるデータベースオブジェクトを一意的に特定するために充分な情報を所有する行を返します。 この情報は機械による解読目的で決して翻訳されません。 データベースオブジェクトの型を特定するtype識別子、 オブジェクトが所属するスキーマの名前であるschema、またはスキーマに所属しないオブジェクト型のNULL、 必要であれば引用符で括られたオブジェクトの名前のnameであって、そのオブジェクトに対する一意の識別子として(もし付属としてあるとした時、一緒にあるスキーマ名)使用されるもの。そうでなければNULLidentityはオブジェクト型に依存する詳細なフォーマットを持つ完結したオブジェクトの識別。そしてフォーマットの中のそれぞれの部分はスキーマ権限を与えられていて、必要な場合は括弧で括られる。

pg_typeofは、OIDに渡される値のデータ型のOIDを返します。これはトラブル解決作業、または動的にSQL問い合わせを生成するのに便利です。この関数は、OID型の別名であるregtypeを返すものとして宣言されます(項8.18を参照)。つまり、比較目的でのOIDと同一ですが、型名として表示されます。以下に例をあげます。

SELECT pg_typeof(33);

 pg_typeof 
-----------
 integer
(1 row)

SELECT typlen FROM pg_type WHERE oid = pg_typeof(33);
 typlen 
--------
      4
(1 row)

collation for式は、それに渡された値の照合順序を返します。例を示します。

SELECT collation for (description) FROM pg_description LIMIT 1;
 pg_collation_for 
------------------
 "default"
(1 row)

SELECT collation for ('foo' COLLATE "de_DE");
 pg_collation_for 
------------------
 "de_DE"
(1 row)

値はクォートで囲い、スキーマを明示的に指定します。もし引数の式から何も照合順序が得られなかった場合、NULLが返されます。もし引数が照合順序をサポートしないデータ型だった場合、エラーとなります。

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

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

名前戻り型説明
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_descriptionは、共有オブジェクトのコメント取得のために使用されることを除いて、obj_descriptionと同じように使用されます。一部のシステムカタログは、各クラスタ内のデータベース全体に対して大域的です。これらのコメントも同様に大域的に格納されます。

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

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

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

内部トランザクションID型(xid)は32ビット幅あるので40億トランザクション毎ラップします。とは言っても、これらの関数は"epoch"カウンタにより64ビット形式にエクスポートするため、インストレーションの生涯にわたってラップしません。これらの関数で使用されるデータ型、txid_snapshotはある時間特有時のトランザクションIDの可視化に関する情報を格納します。構成要素は表9-57に記載されています。

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

名前説明
xmin いまだ使用中の最先として出現したトランザクションID(txid)。全ての最も早期のトランザクションはコミットされ、可視化となるか、またはロールバックされ消滅するのいずれか。
xmax 最初のまだ割り当てられていないtxid。これと等しいかより大きい全てのtxidはスナップショットの時点で未開始。従って不可視。
xip_list スナップショット時の使用中のtxid。リストはxminxmax間にのみ使用中のtxidを含む。xmaxより高位の使用中のtxidが存在することもある。 xmin <= txid < xmaxであり、このリストにないtxidはスナップショット時に既に完了している。従い、コミット状態で可視か消滅かのいづれか。リストには副トランザクションのtxidは含まれない。

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