Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

Call a User-Defined Function

  • Capella Operational
  • how-to
    +
    Call a user-defined JavaScript function from the Query Tab or cbq and use it with your Capella operational cluster.

    A user-defined function can be called like any other SQL++ function.

    Prerequisites

    • If you want to use cbq to run your user-defined function, you must complete the prerequisites for using cbq. For more information, see Prerequisites.

    • You have created a user-defined function. For more information, see Create a User-Defined Function.

    Procedure

    You can run user-defined functions from the Query Tab or cbq.

    • Query Tab

    • cbq

    To run a user-defined function from the Query Tab:

    1. On the Operational Clusters page, select the operational cluster where you want to work with your user-defined function.

    2. Go to Data Tools  Query.

    3. Enter a SQL++ statement in the query editor to run your function.

      If you created a scoped user-defined function, make sure your query context is set to the same bucket and scope as the namespace for your function.

      For example, the following statement executes a function called GetBusinessDays, which takes 2 dates:

      EXECUTE FUNCTION GetBusinessDays("02/14/2025", "04/16/2025");

      You can also use a user-defined function in any SQL++ statement, just like a standard built-in function. For example:

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

    To run a user-defined function using the command line tool, cbq:

    1. Open a terminal window.

    2. Navigate to the directory where you installed cbq.

    3. Connect to your Capella operational cluster. For more information, see Connecting to the Cluster.

    4. Run the EXECUTE FUNCTION command with your user-defined function.

      For example, the following command executes a function called GetBusinessDays, which takes 2 dates, on the travel-sample/inventory keyspace:

      EXECUTE FUNCTION default:`travel-sample`.`inventory`.GetBusinessDays("03/10/2025", "05/10/2025");

      You can also use a user-defined function in any SQL++ statement, just like a standard built-in function. For example:

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

    See Also