本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# pgactive 函數參考
<a name="pgactive-functions-reference"></a>

以下列出 pgactive 函數及其參數、傳回值，和協助您有效加以使用的實務使用須知：

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

擷取指定節點的上次套用交易資訊。

**Arguments (引數)**  
+ 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>

暫停複寫套用程序。

**Arguments (引數)**  
無

**傳回類型**  
boolean

**使用須知**  
呼叫此函數可暫停複寫套用程序。

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

繼續複寫套用程序。

**Arguments (引數)**  
無

**傳回類型**  
void

**使用須知**  
呼叫此函數可繼續複寫套用程序。

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

檢查複寫目前是否暫停。

**Arguments (引數)**  
無

**傳回類型**  
boolean

**使用須知**  
使用此函數可檢查複寫套用目前是否暫停。

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

藉由將獨立資料庫轉換為初始節點，來建立 pgactive 群組。



**Arguments (引數)**  
+ node\_name (文字)
+ node\_dsn (文字)
+ apply\_delay integer DEFAULT NULL::integer - replication\_sets text[] DEFAULT ARRAY[‘default’::text]

**傳回類型**  
void

**使用須知**  
藉由將獨立資料庫轉換為初始節點，來建立 pgactive 群組。此函數會在節點轉換為 pgactive 節點之前執行健全性檢查。使用此函數之前，請確定 PostgreSQL 叢集有足夠的 `max_worker_processes` 可支援 pgactive 背景工作者。

## pgactive\_detach\_nodes
<a name="pgactive-detach-nodes"></a>

從 pgactive 群組中移除指定的節點。

**Arguments (引數)**  
+ p\_nodes (text[])

**傳回類型**  
void

**使用須知**  
使用此函數可從 pgactive 群組中移除指定的節點。

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

將特定資料表排除於複寫外。

**Arguments (引數)**  
+ p\_relation (regclass)

**傳回類型**  
void

**使用須知**  
使用此函數可將特定資料表排除於複寫外。

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

擷取詳細的複寫延遲資訊，包括節點詳細資訊、WAL 狀態和 LSN 值。

**Arguments (引數)**  
無

**傳回類型**  
SETOF 記錄 - node\_name text - node\_sysid text - application\_name text - slot\_name text - active boolean - active\_pid integer - pending\_wal\_decoding bigint - 在寄件者節點上解碼的 WAL 約略大小 (位元組) - pending\_wal\_to\_apply bigint - 要在接收節點上套用的 WAL 約略大小 (位元組) - 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 複寫統計資料。

**Arguments (引數)**  
無

**傳回類型**  
SETOF 記錄 - 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>

取得特定關係的複寫集組態。

**Arguments (引數)**  
+ relation (regclass)

**傳回類型**  
SETOF 記錄

**使用須知**  
呼叫此函數可取得特定關係的複寫集組態。

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

在複寫中包含特定資料表。

**Arguments (引數)**  
+ p\_relation (regclass)

**傳回類型**  
void

**使用須知**  
使用此函數可在複寫中包含特定資料表。

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

將節點新增至現有的 pgactive 群組。

**Arguments (引數)**  
+ 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 叢集有足夠的 max\_worker\_processes 供 pgactive 背景工作者使用。

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

從本機節點中移除所有 pgactive 元件。

**Arguments (引數)**  
+ force (布林值，預設值：false)

**傳回類型**  
void

**使用須知**  
呼叫此函數，從本機節點中移除所有 pgactive 元件。

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

產生節點特定的唯一序列值。

**Arguments (引數)**  
+ regclass

**傳回類型**  
bigint

**使用須知**  
使用此函數可產生節點特定的唯一序列值。

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

更新 pgactive 節點的連線資訊。

**Arguments (引數)**  
+ node\_name\_to\_update (文字)
+ node\_dsn\_to\_update (文字)

**傳回類型**  
void

**使用須知**  
使用此函數可更新 pgactive 節點的連線資訊。

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

監控群組建立或加入操作的進度。

**Arguments (引數)**  
+ 逾時 (整數，預設值：0)
+ progress\_interval (整數，預設值：60)

**傳回類型**  
void

**使用須知**  
呼叫此函數可監控群組建立或加入操作的進度。