0Pricing
Neo4j Graph Database Fundamentals · Lezione

Stored procedure e UDF

Imparate a scrivere e distribuire stored procedure e funzioni definite dall'utente personalizzate per incapsulare logiche complesse ed estendere Cypher.

Stored procedure e UDF è una lezione Neo4j Graph Database Fundamentals gratuita su CoddyKit. Questa è la lezione 1 di 4. Puoi leggere la lezione completa qui gratuitamente — poi esercitati direttamente nel browser con un editor di codice integrato e un tutor IA disponibile 24/7. Fa parte del percorso di apprendimento Neo4j Graph Database Fundamentals, e i tuoi progressi si sincronizzano tra il web e l'app CoddyKit. Il corso Neo4j Graph Database Fundamentals include 4 lezioni in totale.

Parti di questa lezione non sono ancora state tradotte e vengono mostrate in inglese.

Extending Neo4j's Capabilities

Welcome to extending Neo4j! Sometimes, Cypher isn't enough for complex logic or specific integrations. That's where custom code comes in.

Neo4j allows you to extend its functionality using Stored Procedures and User-Defined Functions (UDFs), typically written in Java.

  • Stored Procedures perform actions, like creating nodes or running complex algorithms.
  • User-Defined Functions (UDFs) return values, just like built-in Cypher functions.

They encapsulate complex logic, improve query readability, and boost performance for repetitive tasks.

Procedures vs. User-Defined Functions

It's crucial to understand the difference between procedures and UDFs:

  • Stored Procedures:
    - Called with CALL package.procedure()
    - Can perform side effects (create, update, delete data)
    - Return tabular results (rows and columns)
    - Can access the graph database directly
  • User-Defined Functions (UDFs):
    - Called within Cypher expressions (e.g., RETURN my.udf(n.property))
    - Must be pure functions (no side effects)
    - Return a single scalar value (e.g., string, number, boolean, list)
    - Cannot modify the graph or access it directly

Stored Procedure Anatomy (Java)

Stored procedures are Java classes compiled into a JAR file. They use specific Neo4j annotations.

Here's the basic structure for a simple procedure that doesn't take any parameters and returns a string:

package com.coddykit;

import org.neo4j.procedure.Procedure;
import org.neo4j.procedure.Name;
import org.neo4j.procedure.Description;
import org.neo4j.graphdb.Result;
import java.util.stream.Stream;

public class MyProcedures {

    // Define the output record structure
    public static class StringOutput {
        public String value;

        public StringOutput(String value) {
            this.value = value;
        }
    }

    @Procedure(value = "my.hello")
    @Description("Returns a simple greeting.")
    public Stream<StringOutput> hello() {
        return Stream.of(new StringOutput("Hello from CoddyKit!"));
    }
}

Key Elements of a Procedure

Let's break down the previous code:

  • @Procedure(value = "my.hello"): This annotation declares a method as a stored procedure and defines its full name (my.hello).
  • @Description: Provides a description visible in Neo4j Browser.
  • Output Class (StringOutput): Procedures return a Stream of custom objects. Each object represents a row in the result, and its public fields become the column names.
  • Stream<StringOutput>: The return type for procedures.

This Java code is ready to be compiled into a JAR and deployed.

Deploying Your Custom Procedure

To make your Java procedure available in Neo4j, you need to compile it and place the resulting JAR file into the database's plugins directory.

Steps:

  1. Compile your Java code into a JAR file (e.g., my-procedures.jar).
  2. Copy the JAR file into your Neo4j installation's plugins folder.
  3. Restart your Neo4j database instance.

After restarting, Neo4j will discover and register your new procedures and functions.

Calling a Stored Procedure

Once deployed, you can call your procedure using the CALL keyword in Cypher. Let's try calling our my.hello procedure:

CALL my.hello();

User-Defined Function (UDF) Anatomy

UDFs are similar to procedures but have different annotations and return types. They are designed to be used inline within Cypher expressions.

Here's the basic structure for a UDF that takes a string and returns a modified string:

package com.coddykit;

import org.neo4j.procedure.UserFunction;
import org.neo4j.procedure.Name;
import org.neo4j.procedure.Description;

public class MyFunctions {

    @UserFunction("my.capitalize")
    @Description("Capitalizes the first letter of an input string.")
    public String capitalize(@Name("input") String input) {
        if (input == null || input.isEmpty()) {
            return input;
        }
        return Character.toUpperCase(input.charAt(0)) + input.substring(1);
    }
}

Key Elements of a UDF

Let's look at the UDF's components:

  • @UserFunction("my.capitalize"): This annotation declares a method as a UDF and defines its full name (my.capitalize).
  • @Name("input"): Specifies the name for the parameter when used in Cypher.
  • Return Type: UDFs return a single scalar value (e.g., String, Long, Boolean, List<String>). They do not return a Stream or custom output objects.

Like procedures, this Java code must be compiled into a JAR and deployed to the plugins folder.

Calling a User-Defined Function

After deploying your UDF, you can use it directly within Cypher queries as part of an expression. It behaves just like built-in functions.

Let's use our my.capitalize UDF:

RETURN my.capitalize("hello world");

// Or with graph data:
MATCH (p:Person)
RETURN p.name, my.capitalize(p.name) AS CapitalizedName;

Quick Check: Procedures & UDFs

Which of the following statements is TRUE regarding Neo4j Stored Procedures and User-Defined Functions (UDFs)?

Recap & Next Steps

You've learned how to extend Neo4j with custom Java code!

  • Stored Procedures execute complex actions, return tabular results, and are called with CALL.
  • User-Defined Functions (UDFs) return single scalar values, are pure functions (no side effects), and are used inline in Cypher expressions.
  • Both require Java code, specific Neo4j annotations, compilation into a JAR, and deployment to the Neo4j plugins directory.

These powerful extensions allow you to integrate custom logic, algorithms, and external services directly into your Neo4j environment, significantly expanding its capabilities.

Domande Frequenti

La lezione «Stored procedure e UDF» è gratuita?

Sì — il testo completo di «Stored procedure e UDF» è gratuito qui sul web. Per esercitarvi in modo interattivo (un editor di codice integrato e un tutor IA 24/7) e sbloccare il resto del corso Neo4j Graph Database Fundamentals, passa a CoddyKit PRO. Il corso Neo4j Graph Database Fundamentals include 4 lezioni in totale.

Cosa imparerò in «Stored procedure e UDF»?

Imparate a scrivere e distribuire stored procedure e funzioni definite dall'utente personalizzate per incapsulare logiche complesse ed estendere Cypher. Eserciti Neo4j Graph Database Fundamentals con codice pratico che esegui direttamente nel browser, e un tutor IA 24/7 risponde alle tue domande mentre lavori sulla lezione.

Ho bisogno di esperienza per iniziare Neo4j Graph Database Fundamentals?

Non è richiesta alcuna esperienza precedente. Neo4j Graph Database Fundamentals su CoddyKit è strutturato per principianti e studenti avanzati, quindi puoi iniziare da qui o dall'inizio e procedere al tuo ritmo. Questa è la lezione 1 di 4.

Quanto tempo richiede la lezione «Stored procedure e UDF»?

La maggior parte delle lezioni CoddyKit richiede circa 5–10 minuti. Ogni lezione è breve e interattiva, quindi fai progressi costanti e riprendi esattamente da dove hai lasciato su web e app.

Posso scrivere ed eseguire codice in questa lezione Neo4j Graph Database Fundamentals?

Sì. Ogni lezione Neo4j Graph Database Fundamentals include un editor di codice integrato, quindi scrivi ed esegui codice reale direttamente nel tuo browser e ricevi feedback istantaneo dall'IA — nessuna configurazione locale necessaria.

Tutte le lezioni di questo corso

  1. Stored procedure e UDF
  2. Integrazione con strumenti di BI e visualizzazione
  3. Pipeline avanzate di acquisizione dei dati
  4. Ricerca full-text e vettoriale in Neo4j
← Torna a Neo4j Graph Database Fundamentals