User-Defined Functions UI
The Couchbase Server admin console provides a UI for adding user defined functions.
Start at the administration console and selectfrom the menus to access the UDF screen.
Click on the
When you create a new library, an example function (
add) is supplied as an example.
You can delete it when you add your own function, or leave it to serve as a basic example.
You can set a Namespace for your library which will restrict its access to users that have permissions to access the bucket and scope specified by the namespace.
Before you leave the screen, you must set a Library Name.
Click Save to save the library and return to the main UDF screen, or Cancel to cancel without saving the library.
You can edit the library again to add and/or delete functions contained inside it.
You can also delete the whole library by clicking on the drop link.
You can add your own user-defined functions in the lower User-Defined Functions list. These functions can be one of two types:
To add a user-defined function, click on + add function below the User-Defined Functions list.
The Namespace can be set to define the scope that function resides in (
travel-sample.inventory for example).
Users will need permissions to access this namespace to run the function.
The Function Name is the name that will be used in N1QL statements (
EXECUTE FUNCTION for example) to reference your function.
The name must be unique and is case-insensitive.
You can define a list of fixed parameters for your function, or you can use the
… symbol which indicates a variable length function list defined as
The Function Type can be either
If you are defining an
inline function then you can fill in any valid N1QL expression which can then be used as part of another N1QL statement.
This is the default when creating a function.
If you switch Function Type to
Then you select the
Once the details have been filled, you can click the Save Function to save the function and exit the dialog, or click on Cancel to exit the dialog without saving the details.