Class: IClauseJoin

@nginstack/iquery/lib/IClauseJoin~ IClauseJoin


new IClauseJoin(iQuery, iQueryJoin, type)

Classe encarregada de escrever o trecho correspondente a cláusula JOIN no SQL gerado pela classe IQuery.

O parâmetro clause que alguns métodos possuem é um objeto literal que define a condição que deve ser satisfeita para que o banco de dados traga os dados da tabela estrangeira. Equivalente a cláusula ON do SQL. O Objeto literal deve conter as propriedades 'field: ','operator: <=, <>, >=...>' e 'value: '

Parameters:
Name Type Description
iQuery IQuery

Instância da classe IQuery ao qual este objeto está inserido e que é base para toda a construção do SQL.

iQueryJoin IQuery

Instância da classe IQuery que representa a tabela estrangeira no SQL.

type string

Tipo do JOIN que será construído no SQL (Ex: inner, left outer). Não é preciso por a palavra join.

See:
  • IQuery

Members


iQuery :IQuery

Retorna a instância da classe IQuery que representa a tabela local no SQL.

Type:
  • IQuery

iQueryJoin :IQuery

Retorna a instância da classe IQuery que representa a tabela estrangeira no SQL.

Type:
  • IQuery

isRightTableAsSubquery :boolean

Indica se a tabela da direita deste join é uma subquery.

Type:
  • boolean

Methods


getClauseOn(index)

Retorna uma cláusula On do Join.

Parameters:
Name Type Description
index Number

Índice da cláusula On no Join.

Returns:

Cláusula where que corresponde a cláusula On do Join.

Type
IClauseWhere

getClausesOnCount()

Retorna a quantidade de cláusulas On do Join.

Returns:

Quantidade de cláusulas On do Join.

Type
Number

getColumnsNames()

Gera o sql dos campos que devem estar presentes na cláusula select mais externos. Utilizado apenas em caso de subquery na cláusula 'on'.

Returns:

Contém 2 arrays com nomes das colunas: completeColumnsNames e simpleColumnsNames.

Type
object

getJoinSql()

Converte os atributos do objeto que equivalem a cláusula JOIN em SQL. Caso o objeto iQueryJoin, que representa a tabela estrangeira, possua joins, estes joins também serão convertidos em SQL.

Returns:

Sql da cláusula Join.

Type
string

getWhereSql()

Converte os atributos do objeto iQueryJoin que equivalem a cláusula WHERE em SQL. Caso o objeto iQueryJoin, que representa a tabela estrangeira, possua wheres, estes wheres serão convertidos em SQL. Caso o iQueryJoin possua joins, estes joins também terão seus wheres convertidos em SQL.

Returns:

Sql da cláusula Where.

Type
string

on(clause)

Método responsável por receber a condição da cláusula ON do SQL.

Parameters:
Name Type Description
clause Object

Objeto literal que define a condição que deve ser satisfeita para que o banco de dados traga os dados da tabela estrangeira. Equivalente a cláusula ON do SQL.

Returns:

Retorna o próprio objeto IClauseJoin.

Type
IClauseJoin