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

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

## get\_last\_applied\_xact\_info
<a name="get-last-applied-xact-info"></a>

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

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

**戻り型**  
以下を記録します。  
+ last\_applied\_xact\_id (OID)
+ last\_applied\_xact\_committs (タイムゾーン付きのタイムスタンプ)
+ last\_applied\_xact\_at (タイムゾーン付きのタイムスタンプ)

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

## pgactive\_apply\_pause
<a name="pgactive-apply-pause"></a>

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

**引数**  
なし

**戻り型**  
boolean

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

## pgactive\_apply\_resume
<a name="pgactive-apply-resume"></a>

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

**引数**  
なし

**戻り型**  
void

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

## pgactive\_is\_apply\_paused
<a name="pgactive-is-apply-paused"></a>

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

**引数**  
なし

**戻り型**  
boolean

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

## pgactive\_create\_group
<a name="pgactive-create-group"></a>

スタンドアロンデータベースを初期ノードに変換して 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
<a name="pgactive-detach-nodes"></a>

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

**引数**  
+ p\_nodes (text[])

**戻り型**  
void

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

## pgactive\_exclude\_table\_replication\_set
<a name="pgactive-exclude-table-replication-set"></a>

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

**引数**  
+ p\_relation (regclass)

**戻り型**  
void

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

## pgactive\_get\_replication\_lag\_info
<a name="pgactive-get-replication-lag-info"></a>

ノードの詳細、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
<a name="pgactive-get-stats"></a>

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
<a name="pgactive-get-table-replication-sets"></a>

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

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

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

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

## pgactive\_include\_table\_replication\_set
<a name="pgactive-include-table-replication-set"></a>

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

**引数**  
+ p\_relation (regclass)

**戻り型**  
void

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

## pgactive\_join\_group
<a name="pgactive-join-group"></a>

既存の 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
<a name="pgactive-remove"></a>

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

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

**戻り型**  
void

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

## pgactive\_snowflake\_id\_nextval
<a name="pgactive-snowflake-id-nextval"></a>

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

**引数**  
+ regclass

**戻り型**  
bigint

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

## pgactive\_update\_node\_conninfo
<a name="pgactive-update-node-conninfo"></a>

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

**引数**  
+ node\_name\_to\_update (テキスト)
+ node\_dsn\_to\_update (テキスト)

**戻り型**  
void

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

## pgactive\_wait\_for\_node\_ready
<a name="pgactive-wait-for-node-ready"></a>

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

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

**戻り型**  
void

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