Class: IClauseFrom

@nginstack/engine/lib/iquery/IClauseFrom~ IClauseFrom


new IClauseFrom(iQuery, classKey, alias)

Classe encarregada de escrever o trecho correspondente a cláusula FROM no SQL gerado pela classe IQuery e também por fornecer informações sobre a tabela e classe consultadas.

Parameters:
Name Type Description
iQuery IQuery

Object do tipo iQuery ao qual este objeto pertence.

classKey Number

Chave da classe de dados que contém as informações da tabela do banco de dados que será consultada.

alias string

Alias que será dado a tabela no SQL.

See:
  • IQuery

Members


classFieldName :string

Retorna o nome do campo que guarda a classe do registro na tabela consultada.

Type:
  • string

classKey :number

Retorna a chave da classe consultada no SQL.

Type:
  • number

extraFilter :Array

Retorna os campos que devem ser usados na verificação de permissão de visão. Estes campos são configurados no x-class da classe que será consultada, no formato [ [ CAMPO_DA_TABELA_CONSULTADA, CAMPO_DA_IPERMISSION ] ]

Type:
  • Array

iQuery :IQuery

Instância da classe IQuery ao qual o objeto pertence.

Type:
  • IQuery

joinManager :IJoinManager

Retorna o objeto responsável por administrar os joins associados a este objeto IQuery.

Type:
  • IJoinManager

keyFieldName :string

Retorna o nome do campo que guarda a chave do registro na tabela consultada.

Type:
  • string

permissionFields :Array

Retorna os campos lookups que devem ser usados na verificação de permissão de visão. Estes campos são configurados no x-class da classe que será consultada, no formato [ NOME_DO_CAMPO_1, NOME_DO_CAMPO_2 ]

Type:
  • Array

tableName :string

Retorna o nome da tabela que será consultada no comando SQL.

Type:
  • string

xClassTableName :string

Retorna o nome da tabela como está definido no XClass.

Type:
  • string

Methods


<static> createSequenceAlias()

Cria o sufixo que será concatenado ao alias da tabela consultada no SQL. Este sufixo é um número, do tipo inteiro, gerado a partir do incremento da propriedade _iqueryAlias da sessão do usuário.

Returns:
Type
Number

<static> resetSequenceAlias()

Reinicia o identificador numérico adicionado nos alias gerados pelo IQuery a fim de torná-los únicos.

Utilizado apenas em testes unitários a fim de tornar a execução do IQuery determinística.


fieldCanBeNull(fieldName)

Indica se o campo pode ser null

Parameters:
Name Type Description
fieldName string

Nome do campo.

Returns:

True se o campo puder ser null.

Type
boolean

getFromSql()

Gera o trecho do SQL correspondente à cláusula FROM.

Returns:

Cláusula FROM do SQL.

Type
string

getWhereSql( [join])

Gera o trecho do SQL correspondente à cláusula WHERE onde será feito o filtro de classes.

Parameters:
Name Type Argument Description
join Boolean <optional>

join pai da clausula where.

Returns:

Cláusula FROM do SQL.

Type
string