Database
Database
El módulo Database es responsable de almacenar datos persistentes en la computadora en la que el robot se está ejecutando.
Métodos
insertData
Método responsable de insertar un valor en la base de datos.
const insert = await Database.Robot.save["v1_0_1"]({
key: "Nome",
value: "Roberty"
})
Parámetros obligatorios
key: String|Number - clave para identificar el valor almacenado.value: Any - valor que será almacenado. Puede ser de cualquier tipo.
Parámetros opcionales
robotKey: String - clave para nombrar la base de datos. Si no se completa, se utilizará la clave del robot como predeterminada.
Retorno
La constante o variable creada, como la insert del ejemplo mostrado anteriormente, recibirá un valor del tipo Object. El objeto devuelto tendrá las siguientes propiedades:
insert.key: string - devuelve la clave del valor almacenado.insert.value: Any - devuelve el valor almacenado.
removeData
Método responsable de eliminar un valor de la base de datos.
await Database.Robot.delete["v1_0_1"]({
key: "Nome"
})
Parámetros obligatorios
key: String|Number - clave del valor que será eliminado.
Parámetros opcionales
robotKey: String - clave referente al nombre de la base de datos. Si no se completa, se utilizará la clave del robot como predeterminada.
Retorno
Esta acción no tiene retorno.
countData
Método responsable de contar la cantidad de valores almacenados en la base de datos.
const count = await Database.Robot.count["v1_0_0"]({})
Parámetros obligatorios
No hay parámetros obligatorios.
Parámetros opcionales
robotKey: String - clave referente al nombre de la base de datos. Si no se completa, se utilizará la clave del robot como predeterminada.
Retorno
La constante o variable creada, como la count del ejemplo mostrado anteriormente, recibirá un valor del tipo Number que representa la cantidad de valores almacenados.
getData
Método responsable de obtener un valor de la base de datos.
const find = await Database.Robot.find["v1_0_1"]({
key: "Nome"
})
Parámetros obligatorios
key: String|Number - clave del valor que será recuperado.
Parámetros opcionales
robotKey: String - clave referente al nombre de la base de datos. Si no se completa, se utilizará la clave del robot como predeterminada.
Retorno
La constante o variable creada, como la find del ejemplo mostrado anteriormente, recibirá directamente el valor almacenado para la clave indicada (Any). Si la clave no existe, el retorno será undefined.
getAllKeys
Método responsable de obtener todas las claves de la base de datos.
const getKeys = await Database.Robot.getAllKeys["v1_0_0"]({})
Parámetros obligatorios
No hay parámetros obligatorios.
Parámetros opcionales
robotKey: String - clave referente al nombre de la base de datos. Si no se completa, se utilizará la clave del robot como predeterminada.
Retorno
La constante o variable creada, como la getKeys del ejemplo mostrado anteriormente, recibirá un valor del tipo String[] con todas las claves almacenadas en la base de datos.
getAllValues
Método responsable de obtener todos los valores de la base de datos.
const getValues = await Database.Robot.getAllValues["v1_0_0"]({})
Parámetros obligatorios
No hay parámetros obligatorios.
Parámetros opcionales
robotKey: String - clave referente al nombre de la base de datos. Si no se completa, se utilizará la clave del robot como predeterminada.
Retorno
La constante o variable creada, como la getValues del ejemplo mostrado anteriormente, recibirá un valor del tipo Array con todos los valores almacenados en la base de datos.
clear
Método responsable de eliminar todos los valores de la base de datos.
await Database.Robot.clear["v1_0_0"]({})
Parámetros obligatorios
No hay parámetros obligatorios.
Parámetros opcionales
robotKey: String - clave referente al nombre de la base de datos. Si no se completa, la clave del robot se utilizará por defecto.
Retorno
Esta acción no tiene retorno.