Skip to main content
Acessar Studio

PostgreSQL

O módulo PostgreSQL é responsável por conectar em um SGBD PostgreSQL, realizar queries e manipular os resultados dentro do robô.

Métodos​

connection​

Método responsável por criar uma conexão com um banco de dados PostgreSQL.

const connection = await Database.PostreSQL.connection["v1_0_0"]({
  connectionString: `postgres://userRoberty:robertyBD123@localhost:5432/robertyBD`,
})

Parâmetros obrigatórios​

  • connectionString: String - espera uma string com os parâmetros da conexão. O padrão deve ser seguido conforme o exemplo mostrado anteriormente.

Parâmetros opcionais​

Esta ação não possui parâmetros opcionais.

Retorno​

Esta ação não possui retornos.

close​

Método responsável por fechar uma conexão aberta com um banco de dados PostgreSQL.

await Database.PostreSQL.close["v1_0_0"]({
  connection: connection,
})

Parâmetros obrigatórios​

  • connection: Retorno da ação de conexão - espera a conexão obtida através da ação connection.

Parâmetros opcionais​

Esta ação não possui parâmetros opcionais.

Retorno​

Esta ação não possui retornos.

transactionBegin​

Método responsável por criar uma transação com o SGBD PostgreSQL.

const transaction = await Database.PostreSQL.transactionBegin["v1_0_0"]({
  connection: connection,
})

Parâmetros obrigatórios​

  • connection: Retorno da ação de conexão - espera a conexão obtida através da ação connection.

Parâmetros opcionais​

Esta ação não possui parâmetros opcionais.

Retorno​

Esta ação não possui retornos.

transactionCommit​

Método responsável por aplicar (commitar) uma transação aberta pela ação transactionBegin.

await Database.PostreSQL.transactionCommit["v1_0_0"]({
  connection: connection,
})

Parâmetros obrigatórios​

  • connection: Retorno da ação de conexão - espera a conexão obtida através da ação connection.

Parâmetros opcionais​

Esta ação não possui parâmetros opcionais.

Retorno​

Esta ação não possui retornos.

transactionRollBack​

Método responsável por desfazer uma transação (rollback) aberta pela ação transactionBegin.

await Database.PostreSQL.transactionRollBack["v1_0_0"]({
  connection: connection,
})

Parâmetros obrigatórios​

  • connection: Retorno da ação de conexão - espera a transação obtida através da ação transactionBegin.

Parâmetros opcionais​

Esta ação não possui parâmetros opcionais.

Retorno​

Esta ação não possui retornos.

query​

Método responsável por realizar uma query diretamente no banco de dados através da conexão obtida pela ação connection.

const query = await Database.PostreSQL.query["v1_0_0"]({
  query: `SELECT * FROM tabela;`,
  connection: connection,
  timeout: 120
})

Parâmetros obrigatórios​

  • connection: Retorno da ação de conexão - espera a conexão obtida através da ação connection.
  • query: String - espera uma string com a query a ser realizada.

Parâmetros opcionais​

  • timeout: Number - espera um valor em milissegundos para esperar a execução da query.

Retorno​

A constante ou variável criada, como a query do exemplo mostrado anteriormente, receberá um valor do tipo Object. O objeto retornado terá as seguintes propriedades:

  • query.query: String - retorna a query que foi utilizada.
  • query.results: Array - retorna todos os resultados obtidos com a query.
  • query.resultsCount: Number - retorna a quantidade de linhas obtidas no resultado.