Class: IdoDB

@nginstack/engine/lib/ido/IdoDB~ IdoDB


new IdoDB()

Classe responsável pelo armazenamento e manipulação de uma coleção de tabelas de uma base de dados IDO.

Examples
// Lista os nomes de todas as tabelas da base de dados
 const db = idoDBManager.loadDatabase('TEST');
 db.getTableNames();
// Cria uma nova tabela na base de dados
const db = idoDBManager.createDatabase('TEST');
const ds = new DataSet(db);
ds.fieldDefs.add('fullName', 'string', 150);
ds.create('clients');

Members


indexCount :number

Quantidade total de índices das tabelas abertas na base de dados, como os criados pelas propriedades indexFieldNames e filter dos DataSets.

Type:
  • number
Example
const db = new IdoDBManager().createTempDatabase();
const ds = new DataSet(db);
ds.fieldDefs.add('iKey', 'int64');
ds.create();
ds.indexFieldNames = 'iKey';
ds.first();
db.indexCount; // => 1

name

Nome da base de dados.


pageSize :number

Tamanho em bytes das páginas de dados da base de dados.

Type:
  • number
Example
dbCache.pageSize; // => 4096

size

Tamanho da base de dados em bytes


syncToDisk :boolean

Indica se a base de dados força a gravação dos dados em disco a cada transação. Quando desativada, as gravações são mais rápidas, mas há maior risco de perda de dados em um desligamento forçado do Engine.

Type:
  • boolean
Example
dbCache.syncToDisk; // => true

tableCount :number

Quantidade de tabelas abertas na base de dados.

Type:
  • number
Example
const db = new IdoDBManager().createTempDatabase();
db.tableCount; // => 0

uniqueId

Id único desta base de dados no Engine corrente.

Methods


close()

Encerra esta conexão com a base de dados.

Importante: a base de dados poderá continuar aberta enquanto houver instâncias de DataSet IdoDB que a referenciem.


dropTable(tableName)

Remove uma tabela da base de dados.

Parameters:
Name Type Description
tableName string

Nome da tabela que será removida.


getDBStatistics()

Obtém XML que descreve a base de dados.

Returns:

XML que descreve a base de dados.

Type
string

getTable(tableName)

Obtém um DataSet com o conteúdo da tabela informada.

Parameters:
Name Type Description
tableName string

Nome da tabela que será aberta.

Returns:

DataSet com o conteúdo da tabela informada.

Type
module:@nginstack/engine/lib/dataset/DataSet~DataSet

getTableNames()

Retorna os nomes de todas as tabelas da base de dados.

Returns:

Nomes de todas as tabelas de base de dados.

Type
Array.<string>

tableExists(tableName)

Checa a existência de uma tabela na base de dados IDO.

Parameters:
Name Type Description
tableName string

Nome da tabela que será verificada.

Returns:

Retorna true se a tabela existir.

Type
boolean