QBSorts

Overview

The QBSorts class is a versatile utility for managing sorting conditions in QBSelect queries. It enables developers to define ascending or descending sort orders for columns and functions, offering granular control over query result organization. This class integrates with other query builder components, allowing for dynamic updates to sorting criteria during query construction.

With support for adding primary key columns automatically in alphabetical order, QBSorts streamlines the sorting process in complex queries. Additionally, it includes features for clearing sorting conditions, ensuring flexibility and adaptability. Key methods include add(columnSortAsc) for adding sort orders, addPk() for incorporating primary key columns, and clear() for resetting the sort configuration.

For more details, see the QBSelect documentation.

Properties Summarized

Type	Name	Summary
QBSelect	parent
QBSelect	root	Get query builder parent.

Methods Summarized

Type	Name	Summary
QBSorts	add(columnSortAsc)	Ad an ascending sorting on a column to the query sort.
QBSorts	add(functionSortAsc)	Ad an ascending sorting on a column to the query sort.
QBSorts	add(sort)	Ad a sorting on a column to the query sort.
QBSorts	addPk()	Add the tables' primary pk columns in alphabetical order to the query sort.
QBSorts	clear()	Clear the sorting clause for the query.

Properties Detailed

parent

Type QBSelect the parent QBSelect query associated with these sorts.

root

Get query builder parent.

Type QBSelect

Sample

var subquery = datasources.db.example_data.order_details.createSelect();

	var query = datasources.db.example_data.orders.createSelect();
	query.where.add(query
		.or
			.add(query.columns.order_id.not.isin([1, 2, 3]))

			.add(query.exists(
					subquery.where.add(subquery.columns.orderid.eq(query.columns.order_id)).root
			))
		)

	foundset.loadRecords(query)

Methods Detailed

add(columnSortAsc)

Ad an ascending sorting on a column to the query sort.

Parameters

• QBColumn columnSortAsc column to sort by

Returns: QBSorts this QBSorts instance after adding the specified column to the sort order.

Sample

query.sort.add(query.columns.orderid)

add(functionSortAsc)

Ad an ascending sorting on a column to the query sort.

Parameters

• QBColumn functionSortAsc function to add

Returns: QBSorts this QBSorts instance after adding the specified function to the sort order.

Sample

query.sort.add(query.columns.orderid)

add(sort)

Ad a sorting on a column to the query sort.

Parameters

• QBSort sort the sort to add

Returns: QBSorts this QBSorts instance after adding the specified sort condition.

Sample

query.sort.add(query.columns.orderid.desc)

addPk()

Add the tables' primary pk columns in alphabetical order to the query sort.

Returns: QBSorts this QBSorts instance after adding primary key columns to the sort order.

Sample

query.sort.addPk()

clear()

Clear the sorting clause for the query.

Returns: QBSorts this QBSorts instance after clearing all sort conditions.

Sample

query.sort.clear()

---