> For the complete documentation index, see [llms.txt](https://boxlang.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/query/queryregisterfunction.md).

# QueryRegisterFunction

Register a new scalar or aggregate function for use with Query of Query.

Functions only need to be registered once per runtime and they will be cached in memory until the runtime restarts.

## Method Signature

```
QueryRegisterFunction(name=[string], function=[function], returnType=[string], type=[string])
```

### Arguments

| Argument     | Type       | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Default  |
| ------------ | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- |
| `name`       | `string`   | `true`   | The name of the function to register without parenthesis. You will reference it in your SQL with this name.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |          |
| `function`   | `function` | `true`   | <p>The function to register. This can be a closure or a function reference. For scalar functions, the function will receive a value for each incoming argument and must return a single value.<br>For aggregate functions, the function will receive a value for each incoming argument in the form of an array of values representing each row being aggregated and must return a single value.<br>Null values are not passed into aggregates. Aggregate functions should return a scalar value<br>so the size of the array won't necessarily match the number of rows in the query, and may be different across columns.</p> |          |
| `returnType` | `string`   | `true`   | <p>The return type of the function as a query column type. Default is "Object". This can be any valid query column type. This can be used to enforce<br>how the return values of this function are handled. For example, customFunc() + customFunc2() will behave differently based on whether the custom functions return strings or numbers.</p>                                                                                                                                                                                                                                                                             | `Object` |
| `type`       | `string`   | `true`   | The type of function to register. This can be "scalar" or "aggregate". Default is "scalar".                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | `scalar` |

## Examples

## Related

* [QueryAddColumn](/boxlang-language/reference/built-in-functions/query/queryaddcolumn.md)
* [QueryAddRow](/boxlang-language/reference/built-in-functions/query/queryaddrow.md)
* [QueryAppend](/boxlang-language/reference/built-in-functions/query/queryappend.md)
* [QueryClear](/boxlang-language/reference/built-in-functions/query/queryclear.md)
* [QueryColumnArray](/boxlang-language/reference/built-in-functions/query/querycolumnarray.md)
* [QueryColumnCount](/boxlang-language/reference/built-in-functions/query/querycolumncount.md)
* [QueryColumnData](/boxlang-language/reference/built-in-functions/query/querycolumndata.md)
* [QueryColumnExists](/boxlang-language/reference/built-in-functions/query/querycolumnexists.md)
* [QueryColumnList](/boxlang-language/reference/built-in-functions/query/querycolumnlist.md)
* [QueryCurrentRow](/boxlang-language/reference/built-in-functions/query/querycurrentrow.md)
* [QueryDeleteColumn](/boxlang-language/reference/built-in-functions/query/querydeletecolumn.md)
* [QueryDeleteRow](/boxlang-language/reference/built-in-functions/query/querydeleterow.md)
* [QueryEach](/boxlang-language/reference/built-in-functions/query/queryeach.md)
* [QueryEvery](/boxlang-language/reference/built-in-functions/query/queryevery.md)
* [QueryFilter](/boxlang-language/reference/built-in-functions/query/queryfilter.md)
* [QueryGetCell](/boxlang-language/reference/built-in-functions/query/querygetcell.md)
* [QueryGetResult](/boxlang-language/reference/built-in-functions/query/querygetresult.md)
* [QueryInsertAt](/boxlang-language/reference/built-in-functions/query/queryinsertat.md)
* [QueryKeyExists](/boxlang-language/reference/built-in-functions/query/querykeyexists.md)
* [QueryMap](/boxlang-language/reference/built-in-functions/query/querymap.md)
* [QueryNew](/boxlang-language/reference/built-in-functions/query/querynew.md)
* [QueryNone](/boxlang-language/reference/built-in-functions/query/querynone.md)
* [QueryPrepend](/boxlang-language/reference/built-in-functions/query/queryprepend.md)
* [QueryRecordCount](/boxlang-language/reference/built-in-functions/query/queryrecordcount.md)
* [QueryRecordCount](/boxlang-language/reference/built-in-functions/query/queryrecordcount.md)
* [QueryReduce](/boxlang-language/reference/built-in-functions/query/queryreduce.md)
* [QueryReverse](/boxlang-language/reference/built-in-functions/query/queryreverse.md)
* [QueryRowData](/boxlang-language/reference/built-in-functions/query/queryrowdata.md)
* [QueryRowSwap](/boxlang-language/reference/built-in-functions/query/queryrowswap.md)
* [QuerySetCell](/boxlang-language/reference/built-in-functions/query/querysetcell.md)
* [QuerySetRow](/boxlang-language/reference/built-in-functions/query/querysetrow.md)
* [QuerySlice](/boxlang-language/reference/built-in-functions/query/queryslice.md)
* [QuerySome](/boxlang-language/reference/built-in-functions/query/querysome.md)
* [QuerySort](/boxlang-language/reference/built-in-functions/query/querysort.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/query/queryregisterfunction.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.