# pgactive 関数リファレンス
<a name="pgactive-functions-reference"></a>

以下に、pgactive 関数のリストとそのパラメータ、戻り値、実用的な使用上の注意事項を示します。

## get\$1last\$1applied\$1xact\$1info
<a name="get-last-applied-xact-info"></a>

指定されたノードに最後に適用されたトランザクション情報を取得します。

**引数**  
+ sysid (テキスト) - タイムライン OID
+ dboid (OID)

**戻り型**  
以下を記録します。  
+ last\$1applied\$1xact\$1id (OID)
+ last\$1applied\$1xact\$1committs (タイムゾーン付きのタイムスタンプ)
+ last\$1applied\$1xact\$1at (タイムゾーン付きのタイムスタンプ)

**使用に関する注意事項**  
この関数を使用して、指定されたノードに最後に適用されたトランザクション情報を取得します。

## pgactive\$1apply\$1pause
<a name="pgactive-apply-pause"></a>

レプリケーション適用プロセスを一時停止します。

**引数**  
なし

**戻り型**  
boolean

**使用に関する注意事項**  
この関数を呼び出して、レプリケーション適用プロセスを一時停止します。

## pgactive\$1apply\$1resume
<a name="pgactive-apply-resume"></a>

レプリケーション適用プロセスを再開します。

**引数**  
なし

**戻り型**  
void

**使用に関する注意事項**  
この関数を呼び出して、レプリケーション適用プロセスを再開します。

## pgactive\$1is\$1apply\$1paused
<a name="pgactive-is-apply-paused"></a>

レプリケーション適用が現在一時停止されているかどうかを確認します。

**引数**  
なし

**戻り型**  
boolean

**使用に関する注意事項**  
この関数を使用して、レプリケーション適用が現在一時停止されているかどうかを確認します。

## pgactive\$1create\$1group
<a name="pgactive-create-group"></a>

スタンドアロンデータベースを初期ノードに変換して pgactive グループを作成します。



**引数**  
+ node\$1name (テキスト)
+ node\$1dsn (テキスト)
+ apply\$1delay integer DEFAULT NULL::integer - replication\$1sets text[] DEFAULT ARRAY[‘default’::text]

**戻り型**  
void

**使用に関する注意事項**  
スタンドアロンデータベースを初期ノードに変換して pgactive グループを作成します。この関数は、ノードを pgactive ノードに変換する前に、サニティチェックを実行します。この関数を使用する前に、PostgreSQL クラスターに pgactive バックグラウンドワーカーをサポートするのに十分な `max_worker_processes` が使用可能であることを確認してください。

## pgactive\$1detach\$1nodes
<a name="pgactive-detach-nodes"></a>

pgactive グループから指定されたノードを削除します。

**引数**  
+ p\$1nodes (text[])

**戻り型**  
void

**使用に関する注意事項**  
この関数を使用して、pgactive グループから指定されたノードを削除します。

## pgactive\$1exclude\$1table\$1replication\$1set
<a name="pgactive-exclude-table-replication-set"></a>

レプリケーションから特定のテーブルを除外します。

**引数**  
+ p\$1relation (regclass)

**戻り型**  
void

**使用に関する注意事項**  
この関数を使用して、レプリケーションから特定のテーブルを除外します。

## pgactive\$1get\$1replication\$1lag\$1info
<a name="pgactive-get-replication-lag-info"></a>

ノードの詳細、WAL ステータス、LSN 値など、詳細なレプリケーションラグ情報を取得します。

**引数**  
なし

**戻り型**  
SETOF record - node\$1name text - node\$1sysid text - application\$1name text - slot\$1name text - active boolean - active\$1pid integer - pending\$1wal\$1decoding bigint - Approximate size of WAL in bytes to be decoded on the sender node - pending\$1wal\$1to\$1apply bigint - Approximate size of WAL in bytes to be applied on receiving node - restart\$1lsn pg\$1lsn - confirmed\$1flush\$1lsn pg\$1lsn - sent\$1lsn pg\$1lsn - write\$1lsn pg\$1lsn - flush\$1lsn pg\$1lsn - replay\$1lsn pg\$1lsn

**使用に関する注意事項**  
この関数を呼び出して、ノードの詳細、WAL ステータス、LSN 値などのレプリケーションラグ情報を取得します。

## pgactive\$1get\$1stats
<a name="pgactive-get-stats"></a>

pgactive レプリケーションの統計を取得します。

**引数**  
なし

**戻り型**  
SETOF record - rep\$1node\$1id oid - rilocalid oid - riremoteid text - nr\$1commit bigint - nr\$1rollback bigint - nr\$1insert bigint - nr\$1insert\$1conflict bigint - nr\$1update bigint - nr\$1update\$1conflict bigint - nr\$1delete bigint - nr\$1delete\$1conflict bigint - nr\$1disconnect bigint

**使用に関する注意事項**  
この関数を使用して、pgactive レプリケーションの統計を取得します。

## pgactive\$1get\$1table\$1replication\$1sets
<a name="pgactive-get-table-replication-sets"></a>

特定のリレーションのレプリケーションセット設定を取得します。

**引数**  
+ リレーション (regclass)

**戻り型**  
SETOF レコード

**使用に関する注意事項**  
この関数を呼び出して、特定のリレーションのレプリケーションセット設定を取得します。

## pgactive\$1include\$1table\$1replication\$1set
<a name="pgactive-include-table-replication-set"></a>

レプリケーションに特定のテーブルを含めます。

**引数**  
+ p\$1relation (regclass)

**戻り型**  
void

**使用に関する注意事項**  
この関数を使用して、レプリケーションに特定のテーブルを含めます。

## pgactive\$1join\$1group
<a name="pgactive-join-group"></a>

既存の pgactive グループにノードを追加します。

**引数**  
+ node\$1name (テキスト)
+ node\$1dsn (テキスト)
+ join\$1using\$1dsn (テキスト)
+ apply\$1delay (整数、オプション)
+ replication\$1sets (text[]、デフォルト: ['default'])
+ bypass\$1collation\$1check (ブール値、デフォルト: false)
+ bypass\$1node\$1identifier\$1creation (ブール値、デフォルト: false)
+ bypass\$1user\$1tables\$1check (ブール値、デフォルト: false)

**戻り型**  
void

**使用に関する注意事項**  
この関数を呼び出して、既存の pgactive グループにノードを追加します。PostgreSQL クラスターに pgactive バックグラウンドワーカー用の十分な max\$1worker\$1processes があることを確認します。

## pgactive\$1remove
<a name="pgactive-remove"></a>

ローカルノードからすべての pgactive コンポーネントを削除します。

**引数**  
+ force (ブール値、デフォルト: false)

**戻り型**  
void

**使用に関する注意事項**  
この関数を呼び出して、ローカルノードからすべての pgactive コンポーネントを削除します。

## pgactive\$1snowflake\$1id\$1nextval
<a name="pgactive-snowflake-id-nextval"></a>

ノード固有の一意のシーケンス値を生成します。

**引数**  
+ regclass

**戻り型**  
bigint

**使用に関する注意事項**  
この関数を使用して、ノード固有の一意のシーケンス値を生成します。

## pgactive\$1update\$1node\$1conninfo
<a name="pgactive-update-node-conninfo"></a>

pgactive ノードの接続情報を更新します。

**引数**  
+ node\$1name\$1to\$1update (テキスト)
+ node\$1dsn\$1to\$1update (テキスト)

**戻り型**  
void

**使用に関する注意事項**  
この関数を使用して、pgactive ノードの接続情報を更新します。

## pgactive\$1wait\$1for\$1node\$1ready
<a name="pgactive-wait-for-node-ready"></a>

グループの作成または参加オペレーションの進行状況をモニタリングします。

**引数**  
+ タイムアウト (整数、デフォルト: 0)
+ progress\$1interval (整数、デフォルト: 60)

**戻り型**  
void

**使用に関する注意事項**  
この関数を呼び出して、グループの作成または参加オペレーションの進行状況をモニタリングします。