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.

A newer version of this documentation is available.

View Latest

DROP FUNCTION

  • reference
    +
    The DROP FUNCTION statement enables you to delete a user-defined function.

    RBAC Privileges

    To manage global internal functions, you must have the Manage Global Functions role. To manage scoped internal functions, you must have the Manage Scope Functions role, with permissions on the specified bucket and scope.

    To manage global external functions, you must have the Manage Global External Functions role. To manage scoped external functions, you must have the Manage Scope External Functions role, with permissions on the specified bucket and scope.

    For more details about user roles, see Authorization.

    Syntax

    drop-function ::= 'DROP' 'FUNCTION' function ( 'IF' 'EXISTS' )?
    Syntax diagram: refer to source code listing
    function

    (Required) Refer to Function Name below.

    Function Name

    function ::= ( namespace ':' ( bucket '.' scope '.' )? )? identifier
    Syntax diagram: refer to source code listing

    The name of the function. This is usually an unqualified identifier, such as func1 or `func-1`. In this case, the path to the function is determined by the current query context.

    To delete a global function in a particular namespace, the function name must be a qualified identifier with a namespace, such as default:func1. Similarly, to delete a scoped function in a particular scope, the function name must be a qualified identifier with the full path to a scope, such as default:`travel-sample`.inventory.func1. Refer to Global Functions and Scoped Functions for more information.

    The name of a user-defined function is case-sensitive, unlike that of a built-in function. You must delete the user-defined function using the same case that was used when it was created.

    IF EXISTS Clause

    The optional IF EXISTS clause enables the statement to complete successfully when the specified function doesn’t exist.

    When the function does not exist within the specified context: [1]

    • If this clause is not present, an error is generated.

    • If this clause is present, the statement does nothing and completes without error.

    Usage

    When you drop an external user-defined function, the JavaScript library and function on which the user-defined function depended are not deleted. This enables you to create a new user-defined function with a different name, or a different number of parameters, using the same JavaScript library and function.

    To change or delete the JavaScript library and the JavaScript function, you must use the N1QL Functions REST API. For details, refer to Functions REST API.

    Examples

    Example 1. Drop an inline function

    This statement deletes an inline function called celsius.

    DROP FUNCTION celsius;

    You can run the following query to check that the function is no longer available.

    SELECT * FROM system:functions;
    Example 2. Drop an external function

    These statements delete two external functions:

    1. A function called geohash, which depends on the JavaScript encodeGeoHash function in the geohash-js library;

    2. A function called adjacent, which depends on the JavaScript calculateAdjacent function in the geohash-js library.

    DROP FUNCTION geohash;

DROP FUNCTION adjacent;

    You can run the following command to check that the JavaScript geohash-js library and the encodeGeoHash and calculateAdjacent functions are still available.

    curl -v -X GET \
http://localhost:8093/evaluator/v1/libraries/geohash-js \
-u Administrator:password
    1. That is, you are dropping a global function, and the function does not exist within the specified namespace; or, you are dropping a scoped function, and the function does not exist within the specified scope.