QBJoin
Properties Summarized
Type | Name | Summary |
---|---|---|
Get all the columns of the datasource that can be used for this query (select or where clause) | ||
Specifies a comment of the join. | ||
Returns the join type, one of IQueryBuilderJoin#LEFT_OUTER_JOIN, IQueryBuilderJoin#INNER_JOIN, IQueryBuilderJoin#RIGHT_OUTER_JOIN, IQueryBuilderJoin#FULL_JOIN | ||
Get the joins clause of this table based clause. | ||
Get the on clause for the join. | ||
Get query builder parent table clause, this may be a query or a join clause. | ||
Get query builder parent. |
Methods Summarized
Type | Name | Summary |
---|---|---|
Get a column from the table. | ||
Get a column from the table with given alias. | ||
Returns the datasource for this. | ||
Returns the table alias for this. |
Properties Detailed
columns
Get all the columns of the datasource that can be used for this query (select or where clause)
Type QBColumns
Sample
comment
Specifies a comment of the join.
Type String
Sample
joinType
Returns the join type, one of IQueryBuilderJoin#LEFT_OUTER_JOIN, IQueryBuilderJoin#INNER_JOIN, IQueryBuilderJoin#RIGHT_OUTER_JOIN, IQueryBuilderJoin#FULL_JOIN
Type Number joinType.
joins
Get the joins clause of this table based clause. Joins added to this clause will be based on this table clauses table.
Type QBJoins
Sample
on
Get the on clause for the join.
Type QBLogicalCondition
Sample
parent
Get query builder parent table clause, this may be a query or a join clause.
Type QBTableClause
Sample
root
Get query builder parent.
Type QBSelect
Sample
Methods Detailed
getColumn(name)
Get a column from the table.
Parameters
String name the name of column to get
Returns: QBColumn
Sample
getColumn(columnTableAlias, name)
Get a column from the table with given alias. The alias may be of the main table or any level deep joined table.
Parameters
Returns: QBColumn
Sample
getDataSource()
Returns the datasource for this.
Returns: String the dataSource
getTableAlias()
Returns the table alias for this.
Returns: String the tableAlias
Last updated