Saltar al contenido principal
Ir al Studio
Database

PostgreSQL

PostgreSQL

El módulo PostgreSQL es responsable de conectarse a un SGBD PostgreSQL, realizar consultas y manipular los resultados dentro del robot.

Métodos​

connection​

Método responsable de crear una conexión con una base de datos PostgreSQL.

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

Parámetros obligatorios​

  • connectionString: String - espera un string con los parámetros de la conexión. Se debe seguir el estándar conforme al ejemplo mostrado anteriormente.

Parámetros opcionales​

Esta acción no tiene parámetros opcionales.

Retorno​

Esta acción no tiene retornos.

close​

Método responsable de cerrar una conexión abierta con una base de datos PostgreSQL.

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

Parámetros obligatorios​

  • connection: Retorno de la acción de conexión - espera la conexión obtenida a través de la acción connection.

Parámetros opcionales​

Esta acción no tiene parámetros opcionales.

Retorno​

Esta acción no tiene retornos.

transactionBegin​

Método responsable de crear una transacción con el SGBD PostgreSQL.

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

Parámetros obligatorios​

  • connection: Retorno de la acción de conexión - espera la conexión obtenida a través de la acción connection.

Parámetros opcionales​

Esta acción no tiene parámetros opcionales.

Retorno​

Esta acción no tiene retornos.

transactionCommit​

Método responsable de aplicar (confirmar) una transacción abierta por la acción transactionBegin.

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

Parámetros obligatorios​

  • connection: Retorno de la acción de conexión - espera la conexión obtenida a través de la acción connection.

Parámetros opcionales​

Esta acción no tiene parámetros opcionales.

Retorno​

Esta acción no tiene retornos.

transactionRollBack​

Método responsable de deshacer una transacción (rollback) abierta por la acción transactionBegin.

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

Parámetros obligatorios​

  • connection: Retorno de la acción de conexión - espera la transacción obtenida a través de la acción transactionBegin.

Parámetros opcionales​

Esta acción no tiene parámetros opcionales.

Retorno​

Esta acción no tiene retornos.

query​

Método responsable de realizar una consulta directamente en la base de datos a través de la conexión obtenida por la acción connection.

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

Parámetros obligatorios​

  • connection: Retorno de la acción de conexión - espera la conexión obtenida a través de la acción connection.
  • query: String - espera un string con la consulta que será realizada.

Parámetros opcionales​

  • timeout: Number - espera un valor en milisegundos para esperar la ejecución de la consulta.

Retorno​

La constante o variable creada, como la query del ejemplo mostrado anteriormente, recibirá un valor del tipo Object. El objeto devuelto tendrá las siguientes propiedades:

  • query.query: String - devuelve la consulta que fue utilizada.
  • query.results: Array - devuelve todos los resultados obtenidos con la consulta.
  • query.resultsCount: Number - devuelve la cantidad de filas obtenidas en el resultado.