Skip to main content

Database

O módulo Database é responsável por armazenar dados persistentes em seu computador.

Métodos​

insertData​

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

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

Parâmetros obrigatórios​

  • key: String - espera uma chave para apontar para o valor, caso o campo não seja preenchido, uma chave aleatória será gerada para o valor.
  • value: Any - valor que será armazenado, podendo ser qualquer valor.

Parâmetros opcionais​

  • robotKey: String - espera uma chave para nomear a base de dados, caso o campo não seja preenchido, a chave do robô será utilizada como padrão.

Retorno​

A constante ou variável criada, como a insert do exemplo mostrado anteriormente, receberá o um valor do tipo Objeto que dará acesso 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.

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

Parâmetros obrigatórios​

  • key: String - espera uma chave para apontar para o valor e posteriormente excluir este dado.

Parâmetros opcionais​

  • robotKey: String - espera uma chave referente ao nome da base de dados, caso o campo não seja preenchido, 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 da base de dados.

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 - espera uma chave referente ao nome da base de dados, caso o campo não seja preenchido, 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 que representa a quantidade de valores armazenados no base de dados.

getData​

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

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

Parâmetros obrigatórios​

  • key: String - Espera uma chave responsável pelo valor para aponta-lo.

Parâmetros opcionais​

  • robotKey: String - espera uma chave referente ao nome da base de dados, caso o campo não seja preenchido, a chave do robô será utilizada como padrão.

Retorno​

A constante ou variável criada, como a find do exemplo mostrado anteriormente, receberá o um valor do tipo Objeto que dará acesso as seguintes propriedades:

  • find.key: string - retorna a chave do valor encontrado.
  • find.value: Any - retorna o valor encontrado.

getAllKeys​

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

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 - espera uma chave referente ao nome da base de dados, caso o campo não seja preenchido, 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[]. Esse array de strings possui todas as chaves armazenadas na base de dados.

getAllValues​

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

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 - espera uma chave referente ao nome da base de dados, caso o campo não seja preenchido, 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 String[]. Esse array de strings possui todos os valores armazenados na base de dados.