Neo4j Graph Database Fundamentals · Урок

Хранимые процедуры и UDF

Научитесь писать и развёртывать пользовательские хранимые процедуры и функции, чтобы инкапсулировать сложную логику и расширять Cypher.

«Хранимые процедуры и UDF» — бесплатный урок Neo4j Graph Database Fundamentals на CoddyKit. Это урок 1 из 4. Ты можешь прочитать весь урок бесплатно ниже — а потом практиковать его прямо в браузере с встроенным редактором кода и ИИ-репетитором 24/7. Это часть пути обучения Neo4j Graph Database Fundamentals, и твой прогресс синхронизируется между веб-версией и приложением CoddyKit. Курс Neo4j Graph Database Fundamentals содержит 4 уроков всего.

Части этого урока еще не переведены и отображаются на английском.

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.

Часто задаваемые вопросы

Урок «Хранимые процедуры и UDF» бесплатный?

Да — полный текст урока «Хранимые процедуры и UDF» бесплатно доступен здесь в веб-версии. Чтобы практиковать его интерактивно (встроенный редактор кода и ИИ-репетитор 24/7) и разблокировать остальной курс Neo4j Graph Database Fundamentals, подпишись на CoddyKit PRO. Курс Neo4j Graph Database Fundamentals содержит 4 уроков всего.

Чему я научусь в уроке «Хранимые процедуры и UDF»?

Научитесь писать и развёртывать пользовательские хранимые процедуры и функции, чтобы инкапсулировать сложную логику и расширять Cypher. Ты практикуешь Neo4j Graph Database Fundamentals с помощью реального кода, который запускаешь прямо в браузере, и ИИ-репетитор 24/7 отвечает на твои вопросы во время урока.

Нужен ли мне опыт, чтобы начать Neo4j Graph Database Fundamentals?

Предыдущий опыт не требуется. Neo4j Graph Database Fundamentals на CoddyKit структурирован для всех уровней — от новичков до продвинутых, поэтому ты можешь начать отсюда или с самого начала и учиться в своем темпе. Это урок 1 из 4.

Сколько времени занимает урок «Хранимые процедуры и UDF»?

Большинство уроков CoddyKit занимают около 5–10 минут. Каждый из них компактный и интерактивный, поэтому ты постоянно делаешь прогресс и продолжаешь с того же места в веб-версии и приложении.

Можно ли писать и запускать код в этом уроке Neo4j Graph Database Fundamentals?

Да. Каждый урок Neo4j Graph Database Fundamentals включает встроенный редактор кода, поэтому ты пишешь и запускаешь реальный код прямо в браузере и получаешь моментальную обратную связь от AI — локальная установка не требуется.

Все уроки этого курса

Хранимые процедуры и UDF
Интеграция с инструментами BI и визуализации
Расширенные конвейеры загрузки данных
Полнотекстовый и векторный поиск в Neo4j

← Назад к Neo4j Graph Database Fundamentals