A newer version of this documentation is available.

Calling a User-Defined Function

how-to

Enterprise Edition

March 23, 2025

+ 12

How to call a user-defined function from SQL++ statements.
This guide is for Couchbase Server.

Introduction

A User-Defined Function can be called like any other SQL++ function. The Javascript is not called directly; it is called through the SQL++ User-Defined Function.

Calling the SQL++ User-Defined Function

An SQL++ User-Defined Function can be called from anywhere that a standard SQL++ function can be called.

Query Workbench
REST API
SQL++

Access the Query Workbench UI from the Administration Console.
Set the context to match the namespace of the function you are calling.

Enter the SQL++ statement in the query editor to run your function:

sql++
ViewCopy
EXECUTE FUNCTION GetBusinessDays("02/14/2022", "04/16/2022");

Open up a shell session.

Execute a curl command to run the function:

console
ViewCopy
curl -v http://localhost:8093/query/service \
  -u Administrator:password \
  -d 'statement=EXECUTE FUNCTION default:`travel-sample`.inventory.GetBusinessDays("03/10/2022", "05/10.2022")'

Run the EXECUTE FUNCTION function in the CBQ Shell.

sql++
ViewCopy
EXECUTE FUNCTION default:`travel-sample`.`inventory`.GetBusinessDays("03/10/2022", "05/10.2022");

The SQL++ User-Defined Function can be used in any SQL++ statement in exactly the same way as a standard built-in function.

sql++
ViewCopy
SELECT CASE 
  WHEN  GetBusinessDays('02/14/2022', '4/16/2022') > 44 THEN "true" 
  ELSE "false" 
  END 
  AS response;

Calling a User-Defined Function

Introduction

Calling the SQL++ User-Defined Function

Further Reading