Saltar al contenido principal
Docs
Ir al Studio
Roberty Studio
RPADatabase

Firebird

Firebird

El módulo Firebird es responsable de conectarse a un SGBD Firebird, 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 Firebird.

js
const connection = await Database.Firebird.connection["v1_0_0"]({
  connectionType: "remoteHost",
  host: "localhost",
  port: 3050,
  database: "C:\\dados\\robertyBD.fdb",
  user: "SYSDBA",
  password: "masterkey",
  connectTimeout: 10,
  queryTimeout: 60,
})

Parámetros obligatorios​

  • connectionType: String - espera "localFile" (base de datos en un archivo local) o "remoteHost" (base de datos en un servidor).

Parámetros opcionales​

  • host: String - dirección del servidor Firebird. Se usa solo cuando connectionType es "remoteHost".
  • port: Number - puerto del servidor Firebird. Se usa solo cuando connectionType es "remoteHost".
  • database: String - ruta del archivo de la base de datos.
  • user: String - usuario de la base de datos.
  • password: String - contraseña del usuario.
  • connectTimeout: Number - tiempo máximo, en segundos, para que el servidor acepte la conexión.
  • queryTimeout: Number - tiempo límite predeterminado, en segundos, de toda consulta realizada con esta conexión. 0 = sin límite.

Retorno​

Devuelve la conexión abierta, que debe almacenarse en una variable (como connection en el ejemplo) e indicarse en el parámetro connection de los demás métodos.

La versión v2_0_0 de este método recibe, en lugar de los datos de acceso, el connectionId de una conexión configurada en el workspace (Workspace → Conexiones), además de los mismos connectTimeout y queryTimeout:

js
const connection = await Database.Firebird.connection["v2_0_0"]({
  connectionId: "id-de-la-conexion-configurada-en-el-workspace",
  connectTimeout: 10,
  queryTimeout: 60,
})

close​

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

js
await Database.Firebird.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.

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.Firebird.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 - tiempo límite, en segundos, de esta consulta. Si se omite, se aplica el queryTimeout de la conexión. 0 = sin límite. Al alcanzar el límite, la promesa se rechaza con un error cuyo mensaje comienza con Timeout. Cuando no se indican ni timeout ni el queryTimeout de la conexión, no hay límite. Como Firebird no puede cancelar una consulta en curso, la conexión se cierra y es necesario abrir una nueva.

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.