1
0
Fork 0
arangodb/Documentation/Books/AQL/Functions
Wilfried Goesgens 26ac1ce071 By simran: review UDF documentation. 2016-08-04 13:53:49 +02:00
..
Array.mdpp Documentation improvements 2016-07-25 18:43:30 +02:00
Date.mdpp Documentation corrections (mostly AQL) 2016-05-24 18:46:02 +02:00
Document.mdpp Documentation improvements 2016-07-25 18:43:30 +02:00
Fulltext.mdpp Rename Users documentation to Manual 2016-05-24 16:09:21 +02:00
Geo.mdpp Rename Users documentation to Manual 2016-05-24 16:09:21 +02:00
Miscellaneous.mdpp Add COUNT() and RANGE() to documentation, some improvements 2016-06-03 19:03:36 +02:00
Numeric.mdpp Add COUNT() and RANGE() to documentation, some improvements 2016-06-03 19:03:36 +02:00
README.mdpp By simran: review UDF documentation. 2016-08-04 13:53:49 +02:00
String.mdpp Documentation improvements 2016-07-25 18:43:30 +02:00
TypeCast.mdpp Add COUNT() and RANGE() to documentation, some improvements 2016-06-03 19:03:36 +02:00

README.mdpp

!CHAPTER Functions

AQL supports functions to allow more complex computations. Functions can be
called at any query position where an expression is allowed. The general
function call syntax is:

```js
FUNCTIONNAME(arguments)
```

where *FUNCTIONNAME* is the name of the function to be called, and *arguments*
is a comma-separated list of function arguments. If a function does not need any
arguments, the argument list can be left empty. However, even if the argument
list is empty the parentheses around it are still mandatory to make function
calls distinguishable from variable names.

Some example function calls:

```js
HAS(user, "name")
LENGTH(friends)
COLLECTIONS()
```

In contrast to collection and variable names, function names are case-insensitive, 
i.e. *LENGTH(foo)* and *length(foo)* are equivalent.

!SUBSECTION Extending AQL
 
It is possible to extend AQL with user-defined functions. These functions need to
be written in JavaScript, and be registered before usage in a query. Please refer
to [Extending AQL](../Extending/index.html) for more details.