Functions

This page provides an overview of all functions available in the View query language. Functions perform operations on data and return results that can be used in queries.

Aggregation Functions

Aggregation functions perform calculations across groups of rows.

Function Description Example

Function	Description	Example
`collect([distinct` `expression)`]	Creates a collection of values from multiple rows	`collect(name) AS productNames`
`count(*)`	Counts the number of matching rows	`count(*) AS totalCustomers`

collect([distinct expression)]

Creates a collection of values from multiple rows

collect(name) AS productNames

count(*)

Counts the number of matching rows

count(*) AS totalCustomers

Pagination Functions

Functions that support pagination and result set management.

Function Description Example

Function	Description	Example
`next_page_token()`	Generates a token for retrieving the next page of results	`next_page_token() AS nextPageToken`
`page_token_offset(token)`	Uses a token to determine the starting position for pagination	`OFFSET page_token_offset(:pageToken)`
`has_more()`	Indicates if more results exist beyond the current page	`has_more() AS hasMoreResults`
`total_count()`	Returns the total count of rows matching the query	`total_count() AS totalCount`

next_page_token()

Generates a token for retrieving the next page of results

next_page_token() AS nextPageToken

page_token_offset(token)

Uses a token to determine the starting position for pagination

OFFSET page_token_offset(:pageToken)

has_more()

Indicates if more results exist beyond the current page

has_more() AS hasMoreResults

total_count()

Returns the total count of rows matching the query

total_count() AS totalCount

Text Search Functions

Functions for advanced text searching capabilities.

Function Description Example

Function	Description	Example
`text_search(column, query, [config])`	Performs language-aware text search	`text_search(description, :searchText, 'english')`

text_search(column, query, [config])

Performs language-aware text search

text_search(description, :searchText, 'english')

Function Usage

Functions can be used in different parts of a query:

In the SELECT clause to compute values for the result
With the OFFSET clause for token-based pagination
In the WHERE clause for filtering (text_search only)

Function Categories by Return Type

Boolean Functions

has_more() - Returns true if more results exist beyond the current page
text_search() - Returns true if the text contains the search terms

Numeric Functions

count(*) - Returns the number of rows
total_count() - Returns the total number of matching rows

String Functions

next_page_token() - Returns a string token for pagination

Collection Functions

collect() - Returns a collection of values from multiple rows

Related Features

SELECT clause - Using functions in result projections
Paging - Using pagination functions
WHERE clause - Using functions in filters
Result Mapping - How function results map to Java types