pgactive 関数リファレンス
以下に、pgactive 関数のリストとそのパラメータ、戻り値、実用的な使用上の注意事項を示します。
get_last_applied_xact_info
指定されたノードに最後に適用されたトランザクション情報を取得します。
- 引数
-
-
sysid (テキスト) - タイムライン OID
-
dboid (OID)
-
- 戻り型
-
以下を記録します。
-
last_applied_xact_id (OID)
-
last_applied_xact_committs (タイムゾーン付きのタイムスタンプ)
-
last_applied_xact_at (タイムゾーン付きのタイムスタンプ)
-
- 使用に関する注意事項
-
この関数を使用して、指定されたノードに最後に適用されたトランザクション情報を取得します。
pgactive_apply_pause
レプリケーション適用プロセスを一時停止します。
- 引数
-
なし
- 戻り型
-
boolean
- 使用に関する注意事項
-
この関数を呼び出して、レプリケーション適用プロセスを一時停止します。
pgactive_apply_resume
レプリケーション適用プロセスを再開します。
- 引数
-
なし
- 戻り型
-
void
- 使用に関する注意事項
-
この関数を呼び出して、レプリケーション適用プロセスを再開します。
pgactive_is_apply_paused
レプリケーション適用が現在一時停止されているかどうかを確認します。
- 引数
-
なし
- 戻り型
-
boolean
- 使用に関する注意事項
-
この関数を使用して、レプリケーション適用が現在一時停止されているかどうかを確認します。
pgactive_create_group
スタンドアロンデータベースを初期ノードに変換して pgactive グループを作成します。
- 引数
-
-
node_name (テキスト)
-
node_dsn (テキスト)
-
apply_delay integer DEFAULT NULL::integer - replication_sets text[] DEFAULT ARRAY[‘default’::text]
-
- 戻り型
-
void
- 使用に関する注意事項
-
スタンドアロンデータベースを初期ノードに変換して pgactive グループを作成します。この関数は、ノードを pgactive ノードに変換する前に、サニティチェックを実行します。この関数を使用する前に、PostgreSQL クラスターに pgactive バックグラウンドワーカーをサポートするのに十分な
max_worker_processes
が使用可能であることを確認してください。
pgactive_detach_nodes
pgactive グループから指定されたノードを削除します。
- 引数
-
-
p_nodes (text[])
-
- 戻り型
-
void
- 使用に関する注意事項
-
この関数を使用して、pgactive グループから指定されたノードを削除します。
pgactive_exclude_table_replication_set
レプリケーションから特定のテーブルを除外します。
- 引数
-
-
p_relation (regclass)
-
- 戻り型
-
void
- 使用に関する注意事項
-
この関数を使用して、レプリケーションから特定のテーブルを除外します。
pgactive_get_replication_lag_info
ノードの詳細、WAL ステータス、LSN 値など、詳細なレプリケーションラグ情報を取得します。
- 引数
-
なし
- 戻り型
-
SETOF record - node_name text - node_sysid text - application_name text - slot_name text - active boolean - active_pid integer - pending_wal_decoding bigint - Approximate size of WAL in bytes to be decoded on the sender node - pending_wal_to_apply bigint - Approximate size of WAL in bytes to be applied on receiving node - restart_lsn pg_lsn - confirmed_flush_lsn pg_lsn - sent_lsn pg_lsn - write_lsn pg_lsn - flush_lsn pg_lsn - replay_lsn pg_lsn
- 使用に関する注意事項
-
この関数を呼び出して、ノードの詳細、WAL ステータス、LSN 値などのレプリケーションラグ情報を取得します。
pgactive_get_stats
pgactive レプリケーションの統計を取得します。
- 引数
-
なし
- 戻り型
-
SETOF record - rep_node_id oid - rilocalid oid - riremoteid text - nr_commit bigint - nr_rollback bigint - nr_insert bigint - nr_insert_conflict bigint - nr_update bigint - nr_update_conflict bigint - nr_delete bigint - nr_delete_conflict bigint - nr_disconnect bigint
- 使用に関する注意事項
-
この関数を使用して、pgactive レプリケーションの統計を取得します。
pgactive_get_table_replication_sets
特定のリレーションのレプリケーションセット設定を取得します。
- 引数
-
-
リレーション (regclass)
-
- 戻り型
-
SETOF レコード
- 使用に関する注意事項
-
この関数を呼び出して、特定のリレーションのレプリケーションセット設定を取得します。
pgactive_include_table_replication_set
レプリケーションに特定のテーブルを含めます。
- 引数
-
-
p_relation (regclass)
-
- 戻り型
-
void
- 使用に関する注意事項
-
この関数を使用して、レプリケーションに特定のテーブルを含めます。
pgactive_join_group
既存の pgactive グループにノードを追加します。
- 引数
-
-
node_name (テキスト)
-
node_dsn (テキスト)
-
join_using_dsn (テキスト)
-
apply_delay (整数、オプション)
-
replication_sets (text[]、デフォルト: ['default'])
-
bypass_collation_check (ブール値、デフォルト: false)
-
bypass_node_identifier_creation (ブール値、デフォルト: false)
-
bypass_user_tables_check (ブール値、デフォルト: false)
-
- 戻り型
-
void
- 使用に関する注意事項
-
この関数を呼び出して、既存の pgactive グループにノードを追加します。PostgreSQL クラスターに pgactive バックグラウンドワーカー用の十分な max_worker_processes があることを確認します。
pgactive_remove
ローカルノードからすべての pgactive コンポーネントを削除します。
- 引数
-
-
force (ブール値、デフォルト: false)
-
- 戻り型
-
void
- 使用に関する注意事項
-
この関数を呼び出して、ローカルノードからすべての pgactive コンポーネントを削除します。
pgactive_snowflake_id_nextval
ノード固有の一意のシーケンス値を生成します。
- 引数
-
-
regclass
-
- 戻り型
-
bigint
- 使用に関する注意事項
-
この関数を使用して、ノード固有の一意のシーケンス値を生成します。
pgactive_update_node_conninfo
pgactive ノードの接続情報を更新します。
- 引数
-
-
node_name_to_update (テキスト)
-
node_dsn_to_update (テキスト)
-
- 戻り型
-
void
- 使用に関する注意事項
-
この関数を使用して、pgactive ノードの接続情報を更新します。
pgactive_wait_for_node_ready
グループの作成または参加オペレーションの進行状況をモニタリングします。
- 引数
-
-
タイムアウト (整数、デフォルト: 0)
-
progress_interval (整数、デフォルト: 60)
-
- 戻り型
-
void
- 使用に関する注意事項
-
この関数を呼び出して、グループの作成または参加オペレーションの進行状況をモニタリングします。