query

This type represents a representation of a database query result set.

It provides language specific methods to access columnar data, both as value lists and within iterative loops

Query Methods

addColumn(columnName=[string], datatype=[any], array=[array])

Adds a column to a query and populates its rows with the contents of a one-dimensional array.

Arguments:

addRow(rowData=[any])

Return new query

Arguments:

append(query2=[query])

This function clears the query

Arguments:

clear()

This function clears the query

columnArray()

This function returns the column array of a query.

columnCount()

This function returns the number of columns in a query

columnData(columnName=[string])

Returns the data in a query column.

Arguments:

columnExists(column=[string])

This function returns true if the column exists in the query

Arguments:

currentRow()

Returns the current row number

deleteColumn(column=[string])

Deletes a column within a query object.

Arguments:

deleteRow(row=[integer])

This function deletes a row from the query

Arguments:

each(callback=[function:Consumer], parallel=[boolean], maxThreads=[integer])

Iterates over query rows and passes each row per iteration to a callback function

Arguments:

every(closure=[function:Predicate], parallel=[boolean], maxThreads=[integer])

Executes a callback/closure against every row in a query and returns true if the callback/closure returned true for every row.

Arguments:

filter(callback=[function:Predicate], parallel=[boolean], maxThreads=[integer])

Filters query rows specified in filter criteria

Arguments:

getCell(column_name=[string], row_number=[integer])

This function maps the query to a new query.

Arguments:

getResult()

Returns the metadata of a query.

getRow(rowNumber=[integer])

Returns the cells of a query row as a structure

Arguments:

insertAt(value=[query], position=[numeric])

Inserts a query data into another query at a specific position

Arguments:

isEmpty()

Determine whether a given value is empty.

We check for emptiness of anything that can be casted to: Array, Struct, Query, or String.

keyExists(key=[string])

This function returns true if the key exists in the query

Arguments:

len()

Returns the absolute value of a number

map(callback=[function:Function], parallel=[boolean], maxThreads=[integer])

This function maps the query to a new query.

Arguments:

prepend(query2=[query])

Adds a query to the beginning of another query

Arguments:

recordCount()

This function returns the number of records in a query

reduce(callback=[function:BiFunction], initialValue=[any])

This function reduces the query to a single value.

Arguments:

reverse()

This function reverses the query data

rowData(rowNumber=[integer])

Returns the cells of a query row as a structure

Arguments:

rowSwap(source=[numeric], destination=[numeric])

In a query object, swap the record in the sourceRow with the record from the destinationRow.

Arguments:

setCell(column=[string], value=[any], row=[integer])

Sets a cell to a value.

Arguments:

setRow(rowNumber=[integer], rowData=[any])

Adds or updates a row in a query based on the provided row data and position.

Arguments:

slice(offset=[integer], length=[integer])

Returns a subset of rows from an existing query

Arguments:

some(callback=[function:Predicate], parallel=[boolean], maxThreads=[integer], initialValue=[any])

This function calls a given closure/function with every element in a given query and returns true, if one of the closure calls returns true

Arguments:

sort(sortFunc=[function:Comparator])

Sorts array elements.

Arguments:

toJSON(queryFormat=[string], useSecureJSONPrefix=[string], useCustomSerializer=[boolean])

Converts a BoxLang variable into a JSON (JavaScript Object Notation) string.

Arguments:

toModifiable()

Convert an array, struct or query to its Modifiable counterpart.

toUnmodifiable()

Convert an array, struct or query to its Unmodifiable counterpart.

Examples