Pular para o conteúdo principal
Docs
Acessar Studio
Roberty Studio
RPAMódulos

Database

Database

O módulo Database é responsável por armazenar dados persistentes no computador em que o robô está sendo executado.

Métodos​

insertData​

Método responsável por inserir um valor na base de dados.

js
const insert = await Database.Robot.save["v1_0_1"]({
  key: "Nome",
  value: "Roberty"
})

Parâmetros obrigatórios​

  • key: String|Number - chave para identificar o valor armazenado.
  • value: Any - valor que será armazenado. Pode ser qualquer tipo.

Parâmetros opcionais​

  • robotKey: String - chave para nomear a base de dados. Caso não preenchida, a chave do robô será utilizada como padrão.

Retorno​

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

  • insert.key: string - retorna a chave do valor armazenado.
  • insert.value: Any - retorna o valor armazenado.

removeData​

Método responsável por remover um valor da base de dados.

js
await Database.Robot.delete["v1_0_1"]({
  key: "Nome"
})

Parâmetros obrigatórios​

  • key: String|Number - chave do valor a ser removido.

Parâmetros opcionais​

  • robotKey: String - chave referente ao nome da base de dados. Caso não preenchida, a chave do robô será utilizada como padrão.

Retorno​

Esta ação não possui retorno.

countData​

Método responsável por contar a quantidade de valores armazenados na base de dados.

js
const count = await Database.Robot.count["v1_0_0"]({})

Parâmetros obrigatórios​

Não há parâmetros obrigatórios.

Parâmetros opcionais​

  • robotKey: String - chave referente ao nome da base de dados. Caso não preenchida, a chave do robô será utilizada como padrão.

Retorno​

A constante ou variável criada, como a count do exemplo mostrado anteriormente, receberá um valor do tipo Number representando a quantidade de valores armazenados.

getData​

Método responsável por obter um valor da base de dados.

js
const find = await Database.Robot.find["v1_0_1"]({
  key: "Nome"
})

Parâmetros obrigatórios​

  • key: String|Number - chave do valor a ser recuperado.

Parâmetros opcionais​

  • robotKey: String - chave referente ao nome da base de dados. Caso não preenchida, a chave do robô será utilizada como padrão.

Retorno​

A constante ou variável criada, como a find do exemplo mostrado anteriormente, receberá diretamente o valor armazenado para a chave informada (Any). Caso a chave não exista, o retorno será undefined.

getAllKeys​

Método responsável por obter todas as chaves da base de dados.

js
const getKeys = await Database.Robot.getAllKeys["v1_0_0"]({})

Parâmetros obrigatórios​

Não há parâmetros obrigatórios.

Parâmetros opcionais​

  • robotKey: String - chave referente ao nome da base de dados. Caso não preenchida, a chave do robô será utilizada como padrão.

Retorno​

A constante ou variável criada, como a getKeys do exemplo mostrado anteriormente, receberá um valor do tipo String[] com todas as chaves armazenadas na base de dados.

getAllValues​

Método responsável por obter todos os valores da base de dados.

js
const getValues = await Database.Robot.getAllValues["v1_0_0"]({})

Parâmetros obrigatórios​

Não há parâmetros obrigatórios.

Parâmetros opcionais​

  • robotKey: String - chave referente ao nome da base de dados. Caso não preenchida, a chave do robô será utilizada como padrão.

Retorno​

A constante ou variável criada, como a getValues do exemplo mostrado anteriormente, receberá um valor do tipo Array com todos os valores armazenados na base de dados.

clear​

Método responsável por remover todos os valores da base de dados.

js
await Database.Robot.clear["v1_0_0"]({})

Parâmetros obrigatórios​

Não há parâmetros obrigatórios.

Parâmetros opcionais​

  • robotKey: String - chave referente ao nome da base de dados. Caso não preenchida, a chave do robô será utilizada como padrão.

Retorno​

Esta ação não possui retorno.