Databricks SDK for JavaScript
    Preparing search index...
    Index

    Constructors

    Methods

    • WARNING: This API is experimental and will change in future versions

      Creates a new function

      The user must have the following permissions in order for the function to be created:

      • USE_CATALOG on the function's parent catalog
      • USE_SCHEMA and CREATE_FUNCTION on the function's parent schema

      Parameters

      Returns Promise<FunctionInfo>

    • Deletes the function that matches the supplied name. For the deletion to succeed, the user must satisfy one of the following conditions:

      • Is the owner of the function's parent catalog
      • Is the owner of the function's parent schema and have the USE_CATALOG privilege on its parent catalog
      • Is the owner of the function itself and have both the USE_CATALOG privilege on its parent catalog and the USE_SCHEMA privilege on its parent schema

      Parameters

      Returns Promise<DeleteFunctionResponse>

    • Gets a function from within a parent catalog and schema. For the fetch to succeed, the user must satisfy one of the following requirements:

      • Is a metastore admin
      • Is an owner of the function's parent catalog
      • Have the USE_CATALOG privilege on the function's parent catalog and be the owner of the function
      • Have the USE_CATALOG privilege on the function's parent catalog, the USE_SCHEMA privilege on the function's parent schema, and the EXECUTE privilege on the function itself

      Parameters

      Returns Promise<FunctionInfo>

    • List functions within the specified parent catalog and schema. If the user is a metastore admin, all functions are returned in the output list. Otherwise, the user must have the USE_CATALOG privilege on the catalog and the USE_SCHEMA privilege on the schema, and the output list contains only functions for which either the user has the EXECUTE privilege or the user is the owner. There is no guarantee of a specific ordering of the elements in the array.

      NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.

      PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.

      Parameters

      Returns Promise<ListFunctionsResponse>

    • Updates the function that matches the supplied name. Only the owner of the function can be updated. If the user is not a metastore admin, the user must be a member of the group that is the new function owner.

      • Is a metastore admin
      • Is the owner of the function's parent catalog
      • Is the owner of the function's parent schema and has the USE_CATALOG privilege on its parent catalog
      • Is the owner of the function itself and has the USE_CATALOG privilege on its parent catalog as well as the USE_SCHEMA privilege on the function's parent schema.

      Parameters

      Returns Promise<FunctionInfo>