Cache local

Tabelas do cache local, sincronização com o banco de dados e uso do cache como banco de dados local.

O cache local é uma cópia de tabelas do banco de dados mantida por cada Engine em seus próprios arquivos. As tabelas do cache local são lidas sem acesso ao banco de dados, o que torna a leitura muito mais rápida que a de uma consulta.

O cache local é indicado para as tabelas com grande frequência de leitura e pouca alteração, como as tabelas cadastrais e de configuração. As tabelas de movimentação, pelo seu volume e pela frequência de alterações, não devem ser mantidas no cache local.

A replicação de uma tabela no cache local é definida pela propriedade cachedData da classe que define a tabela, no arquivo x-model. Mais detalhes sobre os arquivos de definição no manual Modelo de dados .

Cada Engine mantém o seu próprio cache local, inclusive os Engines executados nas estações dos usuários.

DataSets do cache local

As tabelas do cache local são lidas e alteradas por meio de DataSets, obtidos pelos métodos dbCache.getTable e classes.getCachedDataSet. A navegação, a leitura e a alteração de registros, a gravação no banco de dados, as pesquisas e os filtros estão descritos no manual DataSet .

O cache local não executa consultas SQL. As consultas ao banco de dados continuam sendo feitas pelo método database.query, e os seus resultados não são gravados no cache local.

O objeto dbCache, instância da classe DBCache , também oferece métodos para consultar a situação das tabelas. O método hasTable indica se a tabela existe no cache local, e o método isCachedTable indica se os registros da tabela estão replicados no cache local ou se ele contém apenas a estrutura da tabela:

const dbCache = require('@nginstack/engine/context/dbCache.js');

if (dbCache.isCachedTable('iGroupUser')) {
  const groupUsers = dbCache.getTable('iGroupUser');
  // ...
}

Sincronização

O Engine sincroniza periodicamente o cache local com o banco de dados, aplicando as alterações gravadas por todos os Engines. Por isso, uma alteração gravada no banco de dados pode levar em torno de um minuto para ser refletida no cache local de cada Engine.

O método dbCache.refresh solicita uma sincronização imediata e, quando o parâmetro wait é true, aguarda a sua conclusão. Para aguardar a sincronização das alterações gravadas pelo próprio código, utilize o parâmetro waitDBCacheSync do método applyUpdates, descrito no tópico Gravação no banco de dados do manual DataSet.

Bases de dados locais

Além das tabelas replicadas do banco de dados, o Engine permite criar bases de dados locais, cujas tabelas são gravadas apenas nos arquivos do próprio Engine e não são sincronizadas com o banco de dados. Essas bases são gerenciadas por duas classes:

  • IdoDBManager : cria, carrega, renomeia e remove as bases de dados. Os dados das bases criadas pelo método createDatabase são gravados no diretório appdbs do diretório de dados do Engine e preservados após a sua finalização. O método createTempDatabase cria bases temporárias, mantidas enquanto o Engine estiver em execução.
  • IdoDB : representa uma base de dados e permite verificar a existência, obter e remover as suas tabelas.

As tabelas são criadas por meio de um DataSet associado à base de dados. Como a criação normalmente ocorre em cenários com execução concorrente, ela deve ser protegida por uma CriticalSection, garantindo que seja realizada por uma única sessão:

const CriticalSection = require('@nginstack/engine/lib/sync/CriticalSection.js');
const DataSet = require('@nginstack/engine/lib/dataset/DataSet.js');
const IdoDBManager = require('@nginstack/engine/lib/ido/IdoDBManager.js');

const criticalSection = new CriticalSection('customersDB');
const idoDBManager = new IdoDBManager();
let customers;
criticalSection.enter();
try {
  const db = idoDBManager.databaseExists('CUSTOMERS')
    ? idoDBManager.loadDatabase('CUSTOMERS')
    : idoDBManager.createDatabase('CUSTOMERS');

  if (db.tableExists('customers')) {
    customers = db.getTable('customers');
  } else {
    customers = new DataSet(db);
    customers.fieldDefs.add('code', 'int32');
    customers.fieldDefs.add('name', 'string', 100);
    customers.fieldDefs.add('value', 'number');
    customers.create('customers');
  }
} finally {
  criticalSection.leave();
}

customers.append();
customers.setField('code', 1);
customers.setField('name', 'João');
customers.setField('value', 100);
customers.post();

As tabelas e as bases de dados são removidas pelos métodos IdoDB.dropTable e IdoDBManager.deleteDatabase:

const db = idoDBManager.loadDatabase('CUSTOMERS');
db.dropTable('customers');
idoDBManager.deleteDatabase('CUSTOMERS');