# Referência de funções da pgactive
<a name="pgactive-functions-reference"></a>

Abaixo, você pode encontrar uma lista de funções da pgactive com os respectivos parâmetros, valores de retorno e observações práticas de uso para ajudar você a usá-las de forma eficaz:

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

Recupera as informações da última transação aplicada para um nó especificado.

**Arguments (Argumentos)**  
+ sysid (text): OID de carimbo de data/hora
+ dboid (OID)

**Tipo de retorno**  
Ela registra o seguinte:  
+ last\_applied\_xact\_id (OID)
+ last\_applied\_xact\_committs (carimbo de data/hora com fuso horário)
+ last\_applied\_xact\_at (carimbo de data/hora com fuso horário)

**Observações de uso**  
Use esta função para recuperar as informações da última transação aplicada para um nó especificado.

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

Pausa o processo apply da replicação.

**Arguments (Argumentos)**  
Nenhum

**Tipo de retorno**  
boolean

**Observações de uso**  
Chame esta função para pausar o processo apply da replicação.

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

Retoma o processo apply da replicação.

**Arguments (Argumentos)**  
Nenhum

**Tipo de retorno**  
nulo

**Observações de uso**  
Chame essa função para retomar o processo apply da replicação.

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

Verifica se o processo apply da replicação está em pausa no momento.

**Arguments (Argumentos)**  
Nenhum

**Tipo de retorno**  
boolean

**Observações de uso**  
Use essa função para verificar se o processo apply da replicação está em pausa no momento.

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

Cria um grupo da pgactive convertendo um banco de dados independente no nó inicial.



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

**Tipo de retorno**  
nulo

**Observações de uso**  
Cria um grupo da pgactive convertendo um banco de dados independente no nó inicial. A função realiza verificações de integridade antes de transformar o nó em um nó pgactive. Antes de usar essa função, o cluster do PostgreSQL deve ter `max_worker_processes` suficientes para comportar operadores em segundo plano da pgactive.

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

Remove os nós especificados do grupo da pgactive.

**Arguments (Argumentos)**  
+ p\_nodes (text[])

**Tipo de retorno**  
nulo

**Observações de uso**  
Use essa função para remover os nós especificados do grupo da pgactive.

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

Exclui uma tabela específica da replicação.

**Arguments (Argumentos)**  
+ p\_relation (regclass)

**Tipo de retorno**  
nulo

**Observações de uso**  
Use essa função para excluir uma tabela específica da replicação.

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

Recupera informações detalhadas do atraso da replicação, incluindo detalhes do nó, status do WAL e valores de LSN.

**Arguments (Argumentos)**  
Nenhum

**Tipo de retorno**  
Registro SETOF: node\_name text, node\_sysid text, application\_name text, slot\_name text, active boolean, active\_pid integer, pending\_wal\_decoding bigint (tamanho aproximado do WAL em bytes a ser decodificado no nó emissor), pending\_wal\_to\_apply bigint (tamanho aproximado do WAL em bytes a ser decodificado no nó receptor), 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

**Observações de uso**  
Chame esta função para recuperar informações sobre o atraso da replicação, incluindo detalhes do nó, status do WAL e valores de LSN.

## pgactive\_get\_stats
<a name="pgactive-get-stats"></a>

Recupera estatísticas de replicação da pgactive.

**Arguments (Argumentos)**  
Nenhum

**Tipo de retorno**  
Registro 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

**Observações de uso**  
Use esta função para recuperar estatísticas de replicação da pgactive.

## pgactive\_get\_table\_replication\_sets
<a name="pgactive-get-table-replication-sets"></a>

Obtém a configuração do conjunto de replicações para uma relação específica.

**Arguments (Argumentos)**  
+ relation (regclass)

**Tipo de retorno**  
Registro SETOF

**Observações de uso**  
Chame esta função para obter a configuração do conjunto de replicações para uma relação específica.

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

Inclui uma tabela específica na replicação.

**Arguments (Argumentos)**  
+ p\_relation (regclass)

**Tipo de retorno**  
nulo

**Observações de uso**  
Use esta função para incluir uma tabela específica na replicação.

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

Adiciona um nó a um grupo existente da pgactive.

**Arguments (Argumentos)**  
+ node\_name (text)
+ node\_dsn (text)
+ join\_using\_dsn (text)
+ apply\_delay (integer, optional)
+ replication\_sets (text[], default: ['default'])
+ bypass\_collation\_check (boolean, default: false)
+ bypass\_node\_identifier\_creation (boolean, default: false)
+ bypass\_user\_tables\_check (boolean, default: false)

**Tipo de retorno**  
nulo

**Observações de uso**  
Chame essa função para adicionar um nó a um grupo existente da pgactive. O cluster do PostgreSQL deve ter max\_worker\_processes suficientes para os operadores em segundo plano da pgactive.

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

Remove todos os componentes da pgactive do nó local.

**Arguments (Argumentos)**  
+ force (boolean, default: false)

**Tipo de retorno**  
nulo

**Observações de uso**  
Chame esta função para remover todos os componentes da pgactive do nó local.

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

Gera valores de sequência exclusivos específicos do nó.

**Arguments (Argumentos)**  
+ regclass

**Tipo de retorno**  
bigint

**Observações de uso**  
Use esta função para gerar valores de sequência exclusivos específicos do nó.

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

Atualiza as informações de conexão de um nó da pgactive.

**Arguments (Argumentos)**  
+ node\_name\_to\_update (text)
+ node\_dsn\_to\_update (text)

**Tipo de retorno**  
nulo

**Observações de uso**  
Usa esta função para atualizar as informações de conexão de um nó da pgactive.

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

Monitora o progresso das operações de criação de grupo ou junção.

**Arguments (Argumentos)**  
+ timeout (integer, default: 0)
+ progress\_interval (integer, default: 60)

**Tipo de retorno**  
nulo

**Observações de uso**  
Chame esta função para monitorar o progresso das operações de criação de grupo ou junção.