Neo4j Graph Database Fundamentals · Aula

Procedimentos Armazenados e UDFs

Aprenda a escrever e implantar procedimentos armazenados personalizados e funções definidas pelo usuário para encapsular lógica complexa e ampliar o Cypher.

Procedimentos Armazenados e UDFs é uma aula grátis de Neo4j Graph Database Fundamentals no CoddyKit. Esta é a aula 1 de 4. Você pode ler a aula completa abaixo gratuitamente — depois pratica ao vivo no navegador com um editor de código integrado e um tutor de IA 24/7. Faz parte do caminho de aprendizado de Neo4j Graph Database Fundamentals, e seu progresso é sincronizado entre a web e o app CoddyKit. O curso de Neo4j Graph Database Fundamentals inclui 4 aulas no total.

Partes desta aula ainda não foram traduzidas e aparecem em inglês.

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:

Compile your Java code into a JAR file (e.g., my-procedures.jar).
Copy the JAR file into your Neo4j installation's plugins folder.
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.

Perguntas Frequentes

A aula “Procedimentos Armazenados e UDFs” é grátis?

Sim — o texto completo de “Procedimentos Armazenados e UDFs” é grátis para ler aqui na web. Para praticá-la interativamente (um editor de código integrado e um tutor de IA 24/7) e desbloquear o restante do curso de Neo4j Graph Database Fundamentals, atualize para CoddyKit PRO. O curso de Neo4j Graph Database Fundamentals inclui 4 aulas no total.

O que vou aprender em “Procedimentos Armazenados e UDFs”?

Aprenda a escrever e implantar procedimentos armazenados personalizados e funções definidas pelo usuário para encapsular lógica complexa e ampliar o Cypher. Você pratica Neo4j Graph Database Fundamentals com código prático que executa diretamente no navegador, e um tutor de IA 24/7 responde suas dúvidas enquanto trabalha na aula.

Preciso ter experiência prévia para começar Neo4j Graph Database Fundamentals?

Nenhuma experiência prévia é necessária. Neo4j Graph Database Fundamentals no CoddyKit é estruturado para alunos iniciantes até avançados, então você pode começar aqui ou desde o início e aprender no seu ritmo. Esta é a aula 1 de 4.

Quanto tempo leva a aula “Procedimentos Armazenados e UDFs”?

A maioria das aulas CoddyKit leva cerca de 5–10 minutos. Cada uma é compacta e interativa, então você faz progresso constante e retoma exatamente de onde parou entre web e app.

Posso escrever e executar código nesta aula de Neo4j Graph Database Fundamentals?

Sim. Cada aula de Neo4j Graph Database Fundamentals inclui um editor de código integrado, então você escreve e executa código real direto no navegador e recebe feedback de IA instantaneamente — nenhuma configuração local necessária.

Todas as aulas deste curso

Procedimentos Armazenados e UDFs
Integração com Ferramentas de BI e Visualização
Pipelines Avançados de Ingestão de Dados
Pesquisa de Texto Completo e Vetorial no Neo4j

← Voltar para Neo4j Graph Database Fundamentals