★PostgreSQLカンファレンス2024 12月6日開催/チケット販売中★
他のバージョンの文書 16 | 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.26. システム管理関数

本節で説明する関数は、PostgreSQLインストレーションの制御と監視を行うために使用されます。

9.26.1. 構成設定関数

表9-63は、実行時構成パラメータの問い合わせや変更に使用できる関数を示しています。

表 9-63. 構成設定関数

名前戻り型説明
current_setting(setting_name) text現在の設定値の取得
set_config(setting_name, new_value, is_local) textパラメータを設定し、新規値を返す

関数current_settingは、設定setting_nameの現在の値を返します。 この関数は、SQLSHOWコマンドと同じです。 以下に例を示します。

SELECT current_setting('datestyle');

 current_setting
-----------------
 ISO, MDY
(1 row)

set_config関数は、パラメータsetting_namenew_valueに設定します。 ただし、is_localtrueの場合、新規値は現在のトランザクションにのみ適用されます。 新規値を現在のセッションに適用する場合は、代わりにfalseを使用してください。 この関数は、SQLのSETコマンドと同じです。 以下に例を示します。

SELECT set_config('log_statement_stats', 'off', false);

 set_config
------------
 off
(1 row)

9.26.2. サーバシグナル送信関数

表9-64に示す関数は、制御用シグナルを他のサーバプロセスに送信します。 これらの関数の使用は、著名な例外を除き、大抵の場合スーパーユーザのみに制限されています。

表 9-64. サーバシグナル送信関数

名前戻り型説明
pg_cancel_backend(pid int) booleanバックエンドの現在の問い合わせを取り消す。もし関数を読ぶユーザが取り消す対象のバックエンドと正確に同じロールを保持している場合は、関数を実行することができます。その他全てのケースでは、スーパーユーザでなければいけません。
pg_reload_conf() booleanサーバプロセスに構成ファイルの再読み込みをさせる
pg_rotate_logfile() booleanサーバログファイルを循環させる
pg_terminate_backend(pid int) booleanバックエンドを終結する。もし関数を読ぶユーザが取り消す対象のバックエンドと正確に同じロールを保持している場合は、関数を実行することができます。その他全てのケースでは、スーパーユーザでなければいけません。

これらのぞれぞれの関数は成功の場合true(真)を返し、そうでない場合はfalse(偽)を返します。

pg_cancel_backendpg_terminate_backendは(それぞれ、SIGINTまたはSIGTERM)シグナルをプロセス識別子で特定されたバックエンドプロセスに送ります。 使用中のバックエンドのプロセス識別子はpg_stat_activityビューのpid列から、もしくは、(UnixではpsWindowsではTask Managerにより)サーバ上のpostgresプロセスをリストすることで見つけられます。 実行中のバックエンドのロールはpg_stat_activityusename列から確認することができます。

pg_reload_confSIGHUPシグナルをサーバに送り、その結果全てのサーバプロセスが構成ファイルを再読み込みすることになります。

pg_rotate_logfileはログファイルマネージャに即座に新規出力ファイルに切替えるよう信号を送ります。 これは組み込みログ取得が起動している場合のみ有効です。起動していない場合はログファイルマネージャの子プロセスが存在しない理由からです。

9.26.3. バックアップ制御関数

表9-65に示す関数はオンラインバックアップの作成を支援するものです。 これらの関数は、リカバリ中には実行できません(pg_is_in_backuppg_backup_start_time、およびpg_xlog_location_diffは除く)。

表 9-65. バックアップ制御関数

名前戻り型説明
pg_create_restore_point(name text) pg_lsnリストア実行用に名前付けされたポイントを作成(スーパーユーザのみ実施可能です)
pg_current_xlog_insert_location() pg_lsn現在のトランザクションログの挿入位置の取得
pg_current_xlog_location() pg_lsn現在のトランザクションログの書き込み位置を取得
pg_start_backup(label text [, fast boolean ]) pg_lsnオンラインバックアップの実行準備(スーパーユーザかレプリケーション用のロールでのみ実施可能です)
pg_stop_backup() pg_lsnオンラインバックアップの実行の終了(スーパーユーザかレプリケーション用のロールでのみ実施可能です)
pg_is_in_backup() boolオンラインでの排他的バックアップが実行中は真。
pg_backup_start_time() timestamp with time zone実行中のオンライン排他的バックアップの開始時刻を取得。
pg_switch_xlog() pg_lsn新しいトランザクションログファイルへの強制移行(スーパユーザのみ実施可能です)
pg_xlogfile_name(location pg_lsn) textトランザクションログの位置を表す文字列をファイル名に変換
pg_xlogfile_name_offset(location pg_lsn) text, integerトランザクションログの位置を表す文字列を、ファイル名とファイル内の10進のバイトオフセットに変換
pg_xlog_location_diff(location pg_lsn, location pg_lsn) numeric2つのトランザクションログの位置差分を算出

pg_start_backupは、ユーザが任意に定義したバックアップラベルを受け付けます。 (通常、格納に使用するバックアップダンプファイルにちなんだ名前が付けられます。) この関数は、データベースクラスタのデータディレクトリにバックアップラベルファイル(backup_label)を書き出し、チェックポイントを実行し、バックアップを始めるトランザクションログの位置をテキスト形式で返します。 ユーザはこの結果値を無視することができますが、便利なこともあるので提供されています。

postgres=# select pg_start_backup('label_goes_here');
 pg_start_backup
-----------------
 0/D4445B8
(1 row)

オプションのboolean型パラメータがあります。 であれば、できる限り高速にpg_start_backupを実行します。 これは、即時のチェックポイントを強制するため、I/O 操作の急激な増加を引き起こし、実行中の問い合わせ全てを遅延させることがあります。

pg_stop_backupは、pg_start_backupで作成されたラベルファイルを削除し、トランザクションログ格納領域にバックアップ履歴ファイルを作成します。 履歴ファイルにはpg_start_backupで付与されたラベル、バックアップのトランザクションログの位置の開始位置、終了位置、バックアップ開始時刻、終了時刻が含まれます。 戻り値は、バックアップの終了トランザクションログの位置です(これも同様に無視可能です)。 終了位置を記録した後、現在のトランザクションログの挿入位置は自動的に、次のトランザクションログに進みます。ですので、終了トランザクションログファイルをすぐにアーカイブし、バックアップを完了させることができます。

pg_switch_xlogは、次のトランザクションログファイルに移動し、現在のファイルをアーカイブできるようにします(アーカイブを続けて使用することを前提とします)。 戻り値は、完了した現在のトランザクションログファイル内の終了トランザクションログの位置に1を加えたものです。 前回のトランザクションログファイルの切り替えからトランザクションログに変化がなければ、pg_switch_xlogは現在使用中のトランザクションログファイルの開始位置を返します。

pg_create_restore_pointはリカバリターゲットとして使用可能な名前付けされたトランザクションログレコードを生成し、それに該当するログ位置を返します。 与えられた名前は、どこまでリカバリをするかを明示的に指定するrecovery_target_nameパラメータに使用することができます。 リカバリ処理はリカバリターゲットに指定した名前と一致した最初の時点で終了するため、同じ名前で複数のリストアポイントを作成することは避けてください。

pg_current_xlog_locationは、上記の関数で使用される同一の書式で現在のトランザクションログの書き込み位置を表示します。 同様にpg_current_xlog_insert_locationは、現在のトランザクションログの挿入位置を表示します。 挿入位置は "論理的"な任意の時点のトランザクションログの終了位置です。一方、書き込み位置は、サーバの内部バッファから書き出された実際の終了位置です。 書き込み位置はサーバ外部から検証可能なものの終端です。通常は、部分的に完了したトランザクションログファイルのアーカイブ処理を行いたい場合に必要とされるものです。 挿入位置はサーバをデバッグする際に主に使用されます。 これらはどちらも読み取りのみの操作であり、スーパーユーザ権限を必要としません。

pg_xlogfile_name_offsetを使用して、上記いずれの関数の結果からも、対応するトランザクションログファイルとバイトオフセットを取り出すことができます。 以下に例を示します。

postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
        file_name         | file_offset 
--------------------------+-------------
 00000001000000000000000D |     4039624
(1 row)

同様に、pg_xlogfile_nameは、トランザクションログファイル名のみを取り出します。 指定したトランザクションログの位置が正確にトランザクションログファイルの境界であった場合、これらの両関数は前のトランザクションログファイルの名前を返します。 通常これは、トランザクションログファイルのアーカイブ動作では好まれる動作です。前のファイルが現在のアーカイブで必要とする最後のファイルであるからです。

pg_xlog_location_diffは、2つのトランザクションログの位置の差分をバイト数で算出します。 この関数はpg_stat_replication表9-65に示される関数と併用することで、レプリケーションの遅延の確認に使用できます。

これらの関数の正しい使用方法については、項24.3を参照してください。

9.26.4. リカバリ制御関数

表9-66に示される関数は、スタンバイサーバの現在のステータス情報を提供します。 これらの関数はリカバリ中、および通常稼動時に実行することができるでしょう。

表 9-66. リカバリ情報関数

名前戻り型説明
pg_is_in_recovery() boolまだリカバリ実施中であれば真を返します。
pg_last_xlog_receive_location() pg_lsnストリーミングレプリケーションにより受信されディスクに書き込みされた、トランザクションログの最後の位置を取得します。ストリーミングレプリケーションが実施されている場合は、この値が単調に増加していくでしょう。リカバリが完了した場合、受信されディスクに書き込まれた最後のWALレコードの位置の値がそのまま残ります。ストリーミングレプリケーションが無効、もしくは開始されていない場合、この関数はNULLを返します。
pg_last_xlog_replay_location() pg_lsnリカバリ中に再生された最後のトランザクションログの位置を取得します。リカバリが実施されている場合は、この値が単調に増加していくでしょう。リカバリが完了した場合は、リカバリ時に適用された最後のWALレコードの値がそのまま残ります。もしサーバがリカバリ無しで普通に起動された場合、この関数はNULLを返します。
pg_last_xact_replay_timestamp() timestamp with time zone リカバリ中に再生された最後のトランザクションのタイムスタンプを取得します。このタイムスタンプは、プライマリにて該当するトランザクションがコミット、もしくはアボートされた際のトランザクションログが生成された時間です。もしリカバリ中に何のトランザクションも再生されていない場合、この関数はNULLを返します。もしリカバリが完了した場合、この関数はリカバリ中に再生した最後のトランザクションの時間を静的に示し続けます。サーバがリカバリ処理無しに開始された場合、この関数はNULLを返します。

表9-67に示す関数は、リカバリの進行を制御する関数です。 これらの関数はリカバリ中のみ実施することが可能です。

表 9-67. リカバリ制御関数

名前戻り型説明
pg_is_xlog_replay_paused() boolリカバリが停止中であれば真を返す
pg_xlog_replay_pause() void即座にリカバリを停止する(スーパーユーザに限定)
pg_xlog_replay_resume() voidもしリカバリ停止中であれば再開する(スーパーユーザに限定)

リカバリ停止中は、それ以降のデータベースへの変更は適用されません。 ホットスタンバイ側であれば、停止以降に発行されたSQLは、同じ一貫性を持ったデータベースのスナップショットを参照することができます。 そしてリカバリが再開されるまで、以降のSQLとプライマリへのSQLの衝突は発生しません。

もしストリーミングレプリケーションが無効の場合、停止状態はいつまでも問題なく継続するでしょう。 一方、ストリーミングレプリケーションによりWALレコードの受信が継続されていた場合、停止時間、WALの生成速度、ディスクの残存容量によりますが、ディスク溢れが発生する可能性があります。

9.26.5. スナップショット同期関数

PostgreSQLはデータベースのセッションに対して、それらのスナップショットを同期させることが可能です。snapshotは、そのスナップショットを使用しているトランザクションがどのデータを可視とできるかを決定します。 同期スナップショットは、2つかそれ以上のセッションにおいて、全く同じデータベース内容を見たい場合に必要となります。もし、2つのセッションが独立したそれぞれのトランザクションを開始しただけであれば、ある第3のトランザクションのコミットが、 2つのトランザクションのSTART TRANSACTIONの狭間で実行される可能性があり、そのため一方のトランザクションではそのコミット結果が見え、他方では見えないという影響を受けてしまうでしょう。

このような問題を解決するため、PostgreSQLではトランザクションが使用しているスナップショットをエクスポートできるようになっています。エクスポートしたトランザクションが開かれ続けている限り、他のトランザクションがそれをインポートすることができ、 そしてこれにより最初のトランザクションと正確に同じとなるデータベースの可視性を保証されます。ただし、これらの(スナップショットを共有している)トランザクションによって発生したデータベースへの変更は、コミットされていないトランザクションによる変更と同様に、(スナップショットを共有している)他のトランザクションには見えないままです。 そのため、既存データに対しては同期されますが、それら自身による変更については通常の振る舞いをします。

スナップショットは、表9-68に示すpg_export_snapshot関数を用いてエクスポートされ、SET TRANSACTIONコマンドを用いてインポートされます。

表 9-68. スナップショット同期関数

名前戻り値型説明
pg_export_snapshot() text現在のスナップショットを保存し、その識別子を返す

pg_export_snapshot関数は現在のスナップショットを保存し、そのスナップショットを識別するtext文字列を返します。 この文字列はスナップショットをインポートしたい(データベース外の)クライアントに渡されなければなりません。 エクスポートしたトランザクションが終わるまでの間のみ、そのスナップショットをインポートすることができます。必要ならばトランザクションを複数回エキスポートすることができます。 REPEATABLE READや上位の隔離レベルでは、トランザクションはその有効期間の間同じスナップショットを使用しますので、これはREAD COMMITTEDトランザクションでのみ有用であることに注意してください。 一旦スナップショットをエクスポートしたトランザクションでは、PREPARE TRANSACTIONによるPREPARE TRANSACTIONを使用するこができなくなります。

エクスポートしたトランザクションの使用方法の詳細についてはSET TRANSACTIONを参照してください。

9.26.6. レプリケーション関数

表9-69に示す関数はレプリケーション機能を制御したり、相互作用したりするためのものです。 基盤となっている機能の情報に関しては項25.2.5項25.2.6を参照してください。 これらの関数の使用はスーパユーザに限定されています。

ここの関数の多くには、レプリケーションプロトコルに等価なコマンドがあります。項49.3を参照してください。

項9.26.5項9.26.4項9.26.3に書かれている関数もレプリケーションに関係するものです。

表 9-69. レプリケーションSQL関数

関数戻り値型説明
pg_create_physical_replication_slot(slot_name name) (slot_name name, xlog_position pg_lsn) slot_nameという名前の新しい物理レプリケーションスロットを作成します。 物理スロットからのストリーミングの変更はストリーミングレプリケーションプロトコルでのみ可能です。項49.3を参照してください。 レプリケーションプロトコルコマンドCREATE_REPLICATION_SLOT ... PHYSICALに対応します。
pg_drop_replication_slot(slot_name name) void slot_nameという名前の物理もしくは論理レプリケーションスロットを削除します。 レプリケーションプロトコルコマンドDROP_REPLICATION_SLOTと同じです。
pg_create_logical_replication_slot(slot_name name, plugin name) (slot_name name, xlog_position pg_lsn) slot_nameという名前の新しい論理(デコード)レプリケーションスロットを作成します。 この関数を呼び出すのはレプリケーションプロトコルコマンドCREATE_REPLICATION_SLOT ... LOGICALと同じ効果があります。
pg_logical_slot_get_changes(slot_name name, upto_lsn pg_lsn, upto_nchanges int, VARIADIC options text[]) (location pg_lsn, xid xid, data text) 変更が最後に消費された時点から開始して、スロットslot_nameの変更を返します。 upto_lsnupto_nchangesがNULLならば論理デコードはWALの最後まで続きます。 upto_lsnが非NULLであれば、デコードは指定されたLSNより前にコミットされたトランザクションのみを含みます。 upto_nchangesが非NULLであれば、デコードにより生成された行の数が指定された値を越えたときに、デコードは止まります。 しかしながら、新しいトランザクションの各コミットをデコードして生成された行を追加した後でしかこの制限は確認されませんので、実際に返される行の数は大きいかもしれないことに注意してください。
pg_logical_slot_peek_changes(slot_name name, upto_lsn pg_lsn, upto_nchanges int, VARIADIC options text[]) (location text, xid xid, data text) 変更が消費されないということを除いて、pg_logical_slot_get_changes()関数と同じように振る舞います。すなわち、将来の呼び出しでは再び同じものが返ります。
pg_logical_slot_get_binary_changes(slot_name name, upto_lsn pg_lsn, upto_nchanges int, VARIADIC options text[]) (location pg_lsn, xid xid, data bytea) 変更はbyteaとして返されるということを除いてpg_logical_slot_get_changes()関数と同じように振る舞います。
pg_logical_slot_peek_binary_changes(slot_name name, upto_lsn pg_lsn, upto_nchanges int, VARIADIC options text[]) (location pg_lsn, xid xid, data bytea) 変更はbyteaとして返され消費されないということを除いてpg_logical_slot_get_changes()関数と同じように振る舞います。すなわち、将来の呼び出しでは再び同じものが返ります。

9.26.7. データベースオブジェクト管理関数

表9-70で示された関数はデータベースオブジェクトのディスク領域を計算します。

表 9-70. データベースオブジェクト容量関数

名前戻り型説明
pg_column_size(any)int特定の値を格納するのに使用される(場合により圧縮された)バイト数
pg_database_size(oid) bigint指定されたOIDのデータベースで使用されるディスク容量
pg_database_size(name) bigint指定された名前のデータベースで使用されるディスク容量
pg_indexes_size(regclass) bigint 指定されテーブルに付与されたインデックスで使用される総ディスク容量。
pg_relation_size(relation regclass, fork text) bigint 指定されたテーブルまたはインデックスの指定されたフォーク('main''fsm''vm'または'init')で使用されるディスク容量
pg_relation_size(relation regclass) bigint pg_relation_size(..., 'main')の省略表現
pg_size_pretty(bigint) text 64ビット整数で表現されたバイト単位のサイズを可読性が高いサイズ単位の書式に変換
pg_size_pretty(numeric) text numeric値で表現されたバイト単位のサイズを可読性が高いサイズ単位の書式に変換
pg_table_size(regclass) bigint 指定されたテーブルで使用される容量の内、すべてのインデックスを除外した(しかしTOAST、空き領域マップ、可視性マップを含む)ディスク総容量。
pg_tablespace_size(oid) bigint指定されたOIDを持つテーブル空間で使用されるディスク容量
pg_tablespace_size(name) bigint指定された名前を持つテーブル空間で使用されるディスク容量
pg_total_relation_size(regclass) bigint 指定されたテーブルで使用される、すべてのインデックスとTOASTデータを含むディスク総容量

pg_column_sizeはどんな個別のデータ値を格納するのにも使用される領域を示します。

pg_total_relation_sizeは、テーブルまたはTOASTテーブルのOIDまたは名前を受け付け、指定されたテーブルと関連する全てのインデックスで使用される総ディスク容量を返します。 この関数はpg_table_size + pg_indexes_size の結果と等しいです。

pg_table_sizeは、テーブルのOIDまたは名前を受け付け、インデックスを除いたテーブルのみで使用されるディスク容量を返します。 (TOAST領域、空き領域マップ、可視性マップを含みます。)

pg_indexes_sizeは、テーブルのOIDまたは名前を受け付け、指定されたテーブル付与されている全てのインデックスで使用されるディスク容量を返します。

pg_database_sizepg_tablespace_sizeはデータベースまたはテーブル空間の名前またはOIDを受付け、そこで使用される総容量を返します。 pg_database_sizeを使うためには、(デフォルトで付与されている)指定されたデータベースにCONNECT権限を持っていなければなりません。 pg_tablespace_sizeを使うためには、それが現在のデータベースのデフォルトテーブル空間でない限り、指定されたテーブル空間にCREATE権限を持っていなければなりません。

pg_relation_sizeは、テーブル、インデックス、またはTOASTテーブルのOIDまたは名前を受け付け、そのリレーションの1つのフォークのディスク容量をバイト単位で返します。 (たいていの目的には、高位の関数pg_total_relation_sizepg_table_sizeを使うのがより便利であることに注意してください。高位の関数はフォークすべての容量を合計します。) 引数1つでは、そのリレーションの主データフォークの容量を返します。 2番目の引数はどのフォークを調査するかを指定するために設定できます。

pg_size_prettyは、適切にkB、MB、GB、もしくはTB単位を使用して目で見て判るようにその他の関数の1つの結果を整形するのに使用可能です。

上記の関数において、テーブルやインデックスをregclass引数として受け取って処理するものがありますが、この引数は単にpg_classシステムカタログにあるテーブルやインデックスのOIDです。 ただし、regclassデータ型が自動で入力変換を行うため、ユーザが手動で該当するOIDを調べる必要はありません。リテラル定数のようにシングルクォートで囲んだテーブル名を記述するだけです。 通常のSQL名に対する処理互換のため、テーブル名をダブルクォートで囲わない限り、テーブル名として入力された文字列は小文字に変換されます。

上記の関数に対し、既存オブジェクトに該当するOIDがないものが渡された場合はNULLが返されます。

表9-71 に示される関数は、データベースオブジェクトに関連する特定のディスクファイルを確認する際の手助けとなります。

表 9-71. データベースオブジェクト位置関数

名前戻り型説明
pg_relation_filenode(relation regclass) oid 指定されたリレーションのファイルノード番号
pg_relation_filepath(relation regclass) text 指定されたリレーションのファイルパス
pg_filenode_relation(tablespace oid, filenode oid) regclass 与えられたテーブル空間とファイルノードに関連するリレーションを見つける

pg_relation_filenodeは、テーブル、インデックス、シーケンス、もしくはTOASTテーブルのOIDまたは名前を受け付け、現在それに充てられている"ファイルノード"を返します。 ファイルノードは、リレーションに使用しているファイル名の基礎部分です(詳しくは項59.1を参照して下さい)。 ほとんどのテーブルについては、結果がpg_class.relfilenodeと同じになります。ただし、いくつかのシステムカタログではrelfilenodeが0になるため、これらのシステムカタログの正しいファイルノードを取得するには、この関数を使用しなければいけません。 この関数は、ビューの様にストレージに格納されないリレーションが指定された場合はNULLを返します。

pg_relation_filepathpg_relation_filenodeと似ていますが、こちらはリレーションのファイルパス名(データベースクラスタのディレクトリであるPGDATAからの相対パス)を返します。

pg_filenode_relationpg_relation_filenodeの逆です。 "テーブル空間"OIDと"ファイルノード"を与えると、関連するリレーションのOIDを返します。 データベースのデフォルトテーブル空間内のテーブルに対しては、テーブル空間は0と指定できます。

9.26.8. 汎用ファイルアクセス関数

表9-72で示されている関数はサーバをホスティングしているマシン上のファイルに対し、生来のアクセスを提供します。 データベースクラスタディレクトリとlog_directoryに存在するファイルのみがアクセス可能です。 クラスタディレクトリ内のファイルに対して相対パスを、そしてログファイルに対してはlog_directory構成設定に一致するパスを使用してください。

表 9-72. 汎用ファイルアクセス関数

名前戻り型説明
pg_ls_dir(dirname text) setof textディレクトリ内容のリスト
pg_read_file(filename text [, offset bigint, length bigint]) textテキストファイルの内容を返す
pg_read_binary_file(filename text [, offset bigint, length bigint]) byteaファイルの内容を返す
pg_stat_file(filename text) recordファイル情報を返す

pg_ls_dirは、特別なエントリである"."、および".."を除いた、指定されたディレクトリの全ての名前を返します。

pg_read_fileは与えられたoffsetから始まり、最大lengthバイト(最初にファイルの終りに到達すればこれより少なくなりますが)テキストファイルの一部分を返します。offsetが負の場合にはファイルの終りから数えた位置から読み出します。 もしoffsetlengthが省略された場合、ファイル全体が返されます。ファイルからのバイトの読み込みは、そのサーバ符号化方式に対する文字列と同様の解釈をされます。そのため、読み込んだバイト列がその符号化方式において有効でない場合にはエラーが投げられます。

pg_read_binary_fileは、結果がbytea値となり、従って符号化の検査がされないことを除き、pg_read_fileと似ています。 convert_from関数と組み合わせることで、この指定した符号化方式でファイルの読み込みを行うことができます。

SELECT convert_from(pg_read_binary_file('file_in_utf8.txt'), 'UTF8');

pg_stat_fileはファイル容量、最終アクセス時刻、最終更新時刻、最後にファイルステータスを変更した時刻(これはUnixプラットフォームのみ)、ファイル作成時刻(Windowsのみ)およびもしディレクトリであればそれを示すbooleanを返します。 典型的な使用法を示します。

SELECT * FROM pg_stat_file('filename');
SELECT (pg_stat_file('filename')).modification;

9.26.9. 勧告的ロック用関数

表9-73に示す関数は勧告的ロックを管理します。 これらの関数の適切な使用方法についての詳細は、項13.3.5を参照してください。

表 9-73. 勧告的ロック用関数

名前戻り型説明
pg_advisory_lock(key bigint) voidセッションレベルの排他勧告的ロックを獲得
pg_advisory_lock(key1 int, key2 int) voidセッションレベルの排他勧告的ロックを獲得
pg_advisory_lock_shared(key bigint) voidセッションレベルの共有勧告的ロックを獲得
pg_advisory_lock_shared(key1 int, key2 int) voidセッションレベルの共有勧告的ロックを獲得
pg_advisory_unlock(key bigint) booleanセッションレベルの排他勧告的ロックを解放
pg_advisory_unlock(key1 int, key2 int) booleanセッションレベルの排他勧告的ロックを解放
pg_advisory_unlock_all() void現在のセッションで保持している全てのセッションレベルの勧告的ロックを解放
pg_advisory_unlock_shared(key bigint) booleanセッションレベルの共有勧告的ロックを解放
pg_advisory_unlock_shared(key1 int, key2 int) booleanセッションレベルの共有勧告的ロックの解放
pg_advisory_xact_lock(key bigint) voidトランザクションレベルの排他勧告的ロックの獲得
pg_advisory_xact_lock(key1 int, key2 int) voidトランザクションレベルの排他勧告的ロックの獲得
pg_advisory_xact_lock_shared(key bigint) voidトランザクションレベルの共有勧告的ロックの獲得
pg_advisory_xact_lock_shared(key1 int, key2 int) voidトランザクションレベルの共有勧告的ロックの獲得
pg_try_advisory_lock(key bigint) boolean可能ならばセッションレベルの排他勧告的ロックを獲得
pg_try_advisory_lock(key1 int, key2 int) boolean可能ならばセッションレベルの排他勧告的ロックを獲得
pg_try_advisory_lock_shared(key bigint) boolean可能ならばセッションレベルの共有勧告的ロックを獲得
pg_try_advisory_lock_shared(key1 int, key2 int) boolean可能ならばセッションレベルの共有勧告的ロックを獲得
pg_try_advisory_xact_lock(key bigint) boolean可能ならばトランザクションレベルの排他勧告的ロックの獲得
pg_try_advisory_xact_lock(key1 int, key2 int) boolean可能ならばトランザクションレベルの排他勧告的ロックの獲得
pg_try_advisory_xact_lock_shared(key bigint) boolean可能ならばトランザクションレベルの共有勧告的ロックの獲得
pg_try_advisory_xact_lock_shared(key1 int, key2 int) boolean可能ならばトランザクションレベルの共有勧告的ロックの獲得

pg_advisory_lockは、アプリケーションが定義したリソースをロックします。キーは単一の64ビットキー値、または、2つの32ビットキー(この2つのキー空間は重複しないことに注意)によって識別されます。 もし、別のセッションが同一リソースに対するロックを保持している場合、関数はリソースが利用可能になるまで待機します。ロックは排他ロックです。 複数のロック要求が待ち状態になります。ですので、同一リソースが3回ロックされた場合、他のセッションが使用できるように解放するためにはロック解除を3回行わなければなりません。

pg_advisory_lock_sharedの動作はpg_advisory_lockと同じですが、他のセッションの共有ロックと共有できるロックである点が異なります。 排他ロック要求のみ締め出されます。

pg_try_advisory_lockpg_advisory_lockと同様ですが、この関数の場合、ロックが利用可能になるまで待機しません。 ロックを即座に取得しtrueを返すか、ロックを即座に獲得できなかった場合にfalseを返すかのいずれかです。

pg_try_advisory_lock_sharedの動作は pg_try_advisory_lockと同じですが、排他ロックではなく共有ロックの獲得を試みます。

pg_advisory_unlockは、事前に獲得したセッションレベルの勧告的排他ロックを解放します。ロックの解放に成功した場合、trueを返します。ロックを保持していない場合、falseを返し、さらに、SQL警告がサーバから報告されます。

pg_advisory_unlock_sharedの動作はpg_advisory_unlockと同じですが、セッションレベルの勧告的共有ロックを解放する点が異なります。

pg_advisory_unlock_allは、現在のセッションで保持するセッションレベルの勧告的ロックをすべて解放します。 (この関数は、クライアントとの接続がぶざまに切れた場合でも、セッション終了時に暗黙的に呼び出されます。)

pg_advisory_xact_lockの動作はpg_advisory_lockと同じですが、現在のトランザクションの終了時に自動的にロックが解放され、明示的なロックの解放はできません。

pg_advisory_xact_lock_sharedの動作はpg_advisory_lock_sharedと同じですが、現在のトランザクションの終了時に自動的にロックが解放され、明示的なロックの解放はできません。

pg_try_advisory_xact_lockの動作はpg_try_advisory_lockと同じですが、ロックが獲得できた場合は現在のトランザクションの終了時に自動的にロックが解放され、明示的なロックの解放はできません。

pg_try_advisory_xact_lock_sharedの動作はpg_try_advisory_lock_sharedと同じですが、ロックが獲得できた場合は現在のトランザクションの終了時に自動的にロックが解放され、明示的なロックの解放はできません。