# 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\$1last\$1applied\$1xact\$1info
<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\$1applied\$1xact\$1id (OID)
+ last\$1applied\$1xact\$1committs (carimbo de data/hora com fuso horário)
+ last\$1applied\$1xact\$1at (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\$1apply\$1pause
<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\$1apply\$1resume
<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\$1is\$1apply\$1paused
<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\$1create\$1group
<a name="pgactive-create-group"></a>

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



**Arguments (Argumentos)**  
+ node\$1name (text)
+ node\$1dsn (text)
+ apply\$1delay integer DEFAULT NULL::integer - replication\$1sets 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\$1detach\$1nodes
<a name="pgactive-detach-nodes"></a>

Remove os nós especificados do grupo da pgactive.

**Arguments (Argumentos)**  
+ p\$1nodes (text[])

**Tipo de retorno**  
nulo

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

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

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

**Arguments (Argumentos)**  
+ p\$1relation (regclass)

**Tipo de retorno**  
nulo

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

## pgactive\$1get\$1replication\$1lag\$1info
<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\$1name text, node\$1sysid text, application\$1name text, slot\$1name text, active boolean, active\$1pid integer, pending\$1wal\$1decoding bigint (tamanho aproximado do WAL em bytes a ser decodificado no nó emissor), pending\$1wal\$1to\$1apply bigint (tamanho aproximado do WAL em bytes a ser decodificado no nó receptor), 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

**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\$1get\$1stats
<a name="pgactive-get-stats"></a>

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

**Arguments (Argumentos)**  
Nenhum

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

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

## pgactive\$1get\$1table\$1replication\$1sets
<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\$1include\$1table\$1replication\$1set
<a name="pgactive-include-table-replication-set"></a>

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

**Arguments (Argumentos)**  
+ p\$1relation (regclass)

**Tipo de retorno**  
nulo

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

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

Adiciona um nó a um grupo existente da pgactive.

**Arguments (Argumentos)**  
+ node\$1name (text)
+ node\$1dsn (text)
+ join\$1using\$1dsn (text)
+ apply\$1delay (integer, optional)
+ replication\$1sets (text[], default: ['default'])
+ bypass\$1collation\$1check (boolean, default: false)
+ bypass\$1node\$1identifier\$1creation (boolean, default: false)
+ bypass\$1user\$1tables\$1check (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\$1worker\$1processes suficientes para os operadores em segundo plano da pgactive.

## pgactive\$1remove
<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\$1snowflake\$1id\$1nextval
<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\$1update\$1node\$1conninfo
<a name="pgactive-update-node-conninfo"></a>

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

**Arguments (Argumentos)**  
+ node\$1name\$1to\$1update (text)
+ node\$1dsn\$1to\$1update (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\$1wait\$1for\$1node\$1ready
<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\$1interval (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.