QBTextColumn

Overview

The QBTextColumn class represents a text column in a QBSelect query.

For more information about constructing and executing queries and columns, refer to the QBSelect section of this documentation.

Extends

QBColumn

Properties Summarized

Type	Name	Summary
QBColumn	bit_length	Create bit_length(column) expression
QBCondition	isNull	Compare column with null.
QBColumn	len	Create length(column) expression
QBColumn	lower	Create lower(column) expression
QBColumn	max	Create an aggregate max expression.
QBColumn	min	Create an aggregate min expression.
QBTextColumnComparable	not	Create a negated condition.
QBColumn	trim	Create trim(column) expression
QBColumn	upper	Create upper(column) expression

Methods Summarized

Type	Name	Summary
QBCondition	between(value1, value2)	Compare column to a range of 2 values or other columns.
QBColumn	coalesce(value)	Create coalesce(arg) expression
QBCondition	eq(value)	Compare column with a value or another column.
QBCondition	ge(value)	Compare column with a value or another column.
QBCondition	gt(value)	Compare column with a value or another column.
QBCondition	isin(query)	Compare column with subquery result.
QBCondition	isin(values)	Compare column with values.
QBCondition	isin(customQuery, args)	Compare column with custom query result.
QBCondition	le(value)	Compare column with a value or another column.
QBCondition	like(pattern)	Compare column with a value or another column.
QBCondition	like(pattern, escape)	Compare column with a value or another column.
QBColumn	locate(arg)	Create locate(arg) expression
QBColumn	locate(arg, start)	Create locate(arg, start) expression
QBCondition	lt(value)	Compare column with a value or another column.
QBColumn	nullif(arg)	Create nullif(arg) expression
QBColumn	substring(pos)	Create substring(pos) expression
QBColumn	substring(pos, len)	Create substring(pos, len) expression

Properties Detailed

bit_length

Create bit_length(column) expression

Type QBColumn

Sample

query.result.add(query.columns.custname.bit_length)

isNull

Compare column with null.

Type QBCondition a QBCondition representing the "is null" comparison.

Sample

query.where.add(query.columns.flag.isNull)

len

Create length(column) expression

Type QBColumn

Sample

query.result.add(query.columns.custname.len)

lower

Create lower(column) expression

Type QBColumn

Sample

query.result.add(query.columns.custname.lower)

max

Create an aggregate max expression.

Type QBColumn a QBColumn representing the sum aggregate function.

Sample

var query = datasources.db.example_data.orders.createSelect();
	query.groupBy.addPk() // have to group by on pk when using having-conditions in (foundset) pk queries
	.root.having.add(query.joins.orders_to_order_details.columns.quantity.count.max(10))
	foundset.loadRecords(query)

min

Create an aggregate min expression.

Type QBColumn a QBColumn representing the minimum aggregate function.

Sample

var query = datasources.db.example_data.orders.createSelect();
	query.groupBy.addPk() // have to group by on pk when using having-conditions in (foundset) pk queries
	.root.having.add(query.joins.orders_to_order_details.columns.quantity.count.min(10))
	foundset.loadRecords(query)

not

Create a negated condition.

Type QBTextColumnComparable a QBColumn representing the negated condition.

Sample

query.where.add(query.columns.flag.not.eq(1))

trim

Create trim(column) expression

Type QBColumn

Sample

query.result.add(query.columns.custname.trim)

upper

Create upper(column) expression

Type QBColumn

Sample

query.result.add(query.columns.custname.upper)

Methods Detailed

between(value1, value2)

Compare column to a range of 2 values or other columns.

Parameters

• Object value1 ;

• Object value2 ;

Returns: QBCondition a QBCondition representing the "between" comparison for the two values.

Sample

query.where.add(query.columns.flag.between(0, 5))

coalesce(value)

Create coalesce(arg) expression

Parameters

• Object value when column is null

Returns: QBColumn a QBColumn representing the coalesce expression.

Sample

query.result.add(query.columns.mycol.coalesce('defval'))

eq(value)

Compare column with a value or another column. Operator: equals

Parameters

• Object value ;

Returns: QBCondition a QBCondition representing the "equals" comparison.

Sample

query.where.add(query.columns.flag.eq(1))

ge(value)

Compare column with a value or another column. Operator: greaterThanOrEqual

Parameters

• Object value ;

Returns: QBCondition a QBCondition representing the "greater than or equal to" comparison.

Sample

query.where.add(query.columns.flag.ge(2))

gt(value)

Compare column with a value or another column. Operator: greaterThan

Parameters

• Object value ;

Returns: QBCondition a QBCondition representing the "greater than" comparison.

Sample

query.where.add(query.columns.flag.gt(0))

isin(query)

Compare column with subquery result.

Parameters

• QBPart query subquery

Returns: QBCondition a QBCondition representing the "in" comparison with a subquery.

Sample

query.where.add(query.columns.flag.isin(query2))

isin(values)

Compare column with values.

Parameters

• Array values array of values

Returns: QBCondition a QBCondition representing the "in" comparison with a list of values.

Sample

query.where.add(query.columns.flag.isin([1, 5, 99]))

isin(customQuery, args)

Compare column with custom query result.

Parameters

• String customQuery custom query

• Array args query arguments

Returns: QBCondition a QBCondition representing the "in" comparison with a custom query and arguments.

Sample

query.where.add(query.columns.ccy.isin("select ccycode from currencies c where c.category = " + query.getTableAlias() + ".currency_category and c.flag = ?", ['T']))

le(value)

Compare column with a value or another column. Operator: lessThanOrEqual

Parameters

• Object value ;

Returns: QBCondition a QBCondition representing the "less than or equal to" comparison.

Sample

query.where.add(query.columns.flag.le(2))

like(pattern)

Compare column with a value or another column. Operator: like

Parameters

• Object pattern the string value of the pattern

Returns: QBCondition the QBCondition that can be added to a where clause

Sample

query.where.add(query.columns.companyname.like('Serv%'))

// case-insensitive compares can be done using the upper (or lower) functions,
// this can be useful when using for example German letters like ß,
query.where.add(query.columns.companyname.upper.like(query.functions.upper('groß%')))

like(pattern, escape)

Compare column with a value or another column. Operator: like, with escape character

Parameters

• Object pattern the string value of the pattern

• Number escape the escape char

Returns: QBCondition the QBCondition that can be added to a where clause

Sample

query.where.add(query.columns.companyname.like('X_%', '_')

locate(arg)

Create locate(arg) expression

Parameters

• Object arg string to locate

Returns: QBColumn the QBIntegerColumn that can be added to the result.

Sample

query.result.add(query.columns.mycol.locate('sample'))

locate(arg, start)

Create locate(arg, start) expression

Parameters

• Object arg string to locate

• Number start start pos

Returns: QBColumn the QBIntegerColumn that can be added to the result.

Sample

query.result.add(query.columns.mycol.locate('sample', 5))

lt(value)

Compare column with a value or another column. Operator: lessThan

Parameters

• Object value ;

Returns: QBCondition a QBCondition representing the "less than" comparison.

Sample

query.where.add(query.columns.flag.lt(99))

nullif(arg)

Create nullif(arg) expression

Parameters

• Object arg object to compare

Returns: QBColumn a QBColumn representing the nullif expression.

Sample

query.result.add(query.columns.mycol.nullif('none'))

substring(pos)

Create substring(pos) expression

Parameters

• Number pos ;

Returns: QBColumn the QBTextColumn that can be added to the result.

Sample

query.result.add(query.columns.mycol.substring(3))

substring(pos, len)

Create substring(pos, len) expression

Parameters

• Number pos ;

• Number len ;

Returns: QBColumn the QBTextColumn that can be added to the result.

Sample

query.result.add(query.columns.mycol.substring(3, 2))

---