OFunction

Interface that controls a database function, which you can in turn use in OrientDB SQL on the database or within your applications.

Using Functions

Functions in OrientDB are stored operations that you can call from the Console or through any of the database driver methods that use OrientDB SQL. OrientDB provides a number of functions by default and the user can define a series of additional functions as need. They are stored in the database as a series of OFunction instances accessible through OMetadata and the OFunctionLibrary.

In order to work with functions from your application, you first need to import the class into your code.

import com.orientechnologies.orient.core.metadata.function.OFunction;

Methods

Each function supports the following methods.

Method	Return Type	Description
`getCode()`	`String`	Retrieves the function code
`getId()`	`ORID`	Retrieves the function Record ID
`getLanguage()`	`String`	Retrieves the name of the scripting language the function uses
`getName()`	`String`	Retrieves the logical name of the function
`getParameters()`	`List<String>`	Retrieves the parameters available for use in the function code
`isIdempotent()`	`boolean`	Determines whether the function performs idempotent queries or executes non-idempotent commands
`setCode()`	`OFunction`	Defines the function code
`setIdempotent()`	`OFunction`	Defines whether the function is idempotent or non-idempotent
`setLanguage()`	`OFunction`	Defines the scripting language the function uses
`setName()`	`OFunction`	Defines the logical name of the function
`setParameters()`	`OFunction`	Defines the parameters available to the function code