nginstack

Class: IQuery

@nginstack/iquery/lib/IQuery~ IQuery

new IQuery()

Classe responsável por gerar o SQL de todas as cláusulas do SQL, com exceção do SELECT.

Members

<static> defaultCheckPermission :boolean

Valor padrão da checagem das permissões.

Type:
  • boolean

clauseFrom :IClauseFrom

Retorna o objeto que representa a cláusula FROM do SQL.

Type:
  • IClauseFrom

joinManager :IJoinManager

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

Type:
  • IJoinManager

validatePermission :number

Indica se devem ser validadas as permissões de visão dos dados no resultado final da consulta.

Type:
  • number

whereClauseCount :number

Quantidade de cláusulas where existentes no objeto.

Type:
  • number

Methods

checkPermission()

Ativa a validação de permissão de visão dos dados no resultado final da consulta.

Returns:

Retorna o próprio objeto.

Type
IQuery

column(field)

Declara uma coluna na cláusula SELECT.

Parameters:
Name Type Description
field IClauseSelect | Record.<*, *>

Coluna que deve ser declarada.
Returns:

Instância da classe IClauseSelect.

Type
IClauseSelect

from(classKey)

Declara a classe que terá os dados consultados.

Parameters:
Name Type Description
classKey number

Chave da classe que será consultada.
Returns:

Retorna o próprio objeto.

Type
IQuery

getLeftJoinIQuery()

Obtém o Query que fica no lado esquerdo do Join, se este iQuery fizer parte de um Join.

Returns:

Join Dono deste iQuery, se este iQuery não participar de Joins, este método irá retornar null

Type
IClauseJoin

getWhereSql( [join])

Retorna o SQL que representa as cláusulas WHERE do objeto.

Parameters:
Name Type Argument Description
join boolean <optional>

Join pai das cláusulas Where.
Returns:

SQL que representa as cláusulas WHERE do objeto.

Type
string

innerJoin(IQuery)

Declara uma cláusula INNER JOIN.

Parameters:
Name Type Description
IQuery IQuery

IQuery que representa a tabela estrangeira na cláusula JOIN.
Returns:

Instância da classe IClauseJoin que representa o JOIN declarado.

Type
IClauseJoin

leftOuterJoin(IQuery)

Declara uma cláusula LEFT OUTER JOIN.

Parameters:
Name Type Description
IQuery IQuery

IQuery que representa a tabela estrangeira na cláusula JOIN.
Returns:

Instância da classe IClauseJoin que representa o JOIN declarado.

Type
IClauseJoin

toSql()

Escreve o SQL equivalente às cláusulas FROM, JOIN e WHERE.

Returns:

SQL que representa às cláusulas FROM, JOIN e WHERE.

Type
string

uncheckPermission()

Desativa a validação de permissão de visão dos dados no resultado final da consulta.

Returns:

Retorna o próprio objeto.

Type
IQuery

where(clause)

Declara uma cláusula WHERE. Pode ser passado um objeto literal representando a cláusula ou um array. Este array tem que ter intercalado um objeto literal, como o citado acima, e o tipo de junção entre as cláusulas. O tipo pode ser AND ou OR.

Parameters:
Name Type Description
clause Array.<*> | Record.<*, *>

Cláusula que deve ser adicionada ao SQL.
Returns:

Retorna o próprio objeto.

Type
IQuery