nginstack

Class: DataModelSchema

@nginstack/engine/lib/schema/DataModelSchema~ DataModelSchema

new DataModelSchema( [options])

Classe que permite obter o esquema da base de dados configurado nos arquivos de definição de modelo (x-model e x-class).

Os nomes das tabelas, colunas e índices retornados pelos métodos desta classe são normalizados em caixa baixa.

Parameters:
Name Type Argument Description
options DataModelSchemaOptions | Partial.<DataModelSchemaOptions> <optional>

Opções no processamento das definições das classes de dados.

Methods

<static> formatUniqueIndexName(tableName, columns)

Formata um nome de índice único a partir do nome da tabela e das colunas indexadas.

Parameters:
Name Type Description
tableName string

Nome da tabela.
columns Array.<string>

Nomes das colunas.
Returns:

Nome do índice.

Type
string

<static> getRemoteSchema(database [, options])

Obtém o esquema de dados configurado nos arquivos de definição de modelo (x-model e x-class) da base de dados informada.

Parameters:
Name Type Argument Description
database Database

Base de dados da qual se deseja obter as informações do esquema do modelo de dados.
options DataModelSchemaOptions | Partial.<DataModelSchemaOptions> <optional>

Opções no processamento das definições das classes de dados.
Returns:

Esquema definido pelo modelo de dados da base remota informada.

Type
DataModelSchemaInfo

getTableColumns(tableName)

Obtém informações das colunas declaradas para a tabela no modelo de dados.

Parameters:
Name Type Description
tableName string

Nome da tabela que será consultada.
Returns:

Informações sobre as colunas definidas para a tabela no modelo de dados.

Type
Array.<ColumnInfo>

getTableIndexes(tableName)

Obtém informações dos índices declarados para a tabela no modelo de dados.

Parameters:
Name Type Description
tableName string

Nome da tabela que será consultada.
Returns:

Informações sobre os índices definidos para a tabela no modelo de dados.

Type
Array.<IndexInfo>

getTables()

Obtém informações das tabelas declaradas no modelo de dados.

Returns:

Informações das tabelas definidas no modelo de dados.

Type
Array.<TableInfo>

getUnmanagedTableColumns(tableName)

Retorna as colunas da tabela que não estão definidas no modelo de dados e que não são gerenciadas pelo sistema.

O cadastro dessas colunas pode ser realizado pelo administrador do sistema por meio de registros da classe "Outras Colunas" (-1898139659) no processo "Desenvolvimento > Base de dados > Outras Colunas".

Parameters:
Name Type Description
tableName string

Nome da tabela que se deseja obter as colunas.
Returns:

Nomes das colunas.

Type
Array.<string>

getUnmanagedTableIndexes(tableName)

Retorna os índices definidos para uma tabela que não são definidos no modelo de dados e que não são gerenciadas pelo sistema.

O cadastro desses índices pode ser realizado pelo administrador do sistema por meio de registros da classe "Outros Índices" (-1898139664) no processo "Desenvolvimento > Base de dados > Outros Índices".

Parameters:
Name Type Description
tableName string

Nome da tabela que se deseja obter os índices.
Returns:

Nomes dos índices.

Type
Array.<string>

getUnmanagedTableNames()

Nomes das tabelas que podem existir na base de dados, mas que não têm o esquema de dados gerenciado pelo sistema ou que foram criadas automaticamente pelas tabela de agregação.

O cadastro dessas tabelas pode ser realizado pelo administrador do sistema por meio de registros da classe "Outras tabelas" (-1898141843) ou via propriedade managedDatabaseSchema.

Returns:

Nomes das tabelas que não têm o esquema de dados gerenciado pelo sistema.

Type
Array.<string>

scanForClassDefErrors()

Verifica se as definições de classes do sistema possuem erros que impeçam a obtenção da configuração do modelo de dados.

Returns:

Erros nas definições das classes.

Type
Array.<ClassDefError>