apoc.help.Help Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of apoc Show documentation

A collection of useful Neo4j Procedures

There is a newer version: 4.4.0.35

package apoc.help;

import org.neo4j.graphdb.GraphDatabaseService;
import org.neo4j.procedure.Context;
import org.neo4j.procedure.Description;
import org.neo4j.procedure.Name;
import org.neo4j.procedure.Procedure;

import java.util.stream.Stream;

import static apoc.util.Util.map;

public class Help {

    @Context
    public GraphDatabaseService db;

    @Procedure("apoc.help")
    @Description("Provides descriptions of available procedures. To narrow the results, supply a search string. To also search in the description text, append + to the end of the search string.")
    public Stream info(@Name("proc") String name) throws Exception {
        boolean searchText = false;
        if (name != null) {
            name = name.trim();
            if (name.endsWith("+")) {
                name = name.substring(0, name.lastIndexOf('+')).trim();
                searchText = true;
            }
        }
        String filter = " WHERE name starts with 'apoc.' " +
                " AND ({name} IS NULL  OR toLower(name) CONTAINS toLower({name}) " +
                " OR ({desc} IS NOT NULL AND toLower(description) CONTAINS toLower({desc}))) " +
                "RETURN type, name, description, signature ";

        String query = "WITH 'procedure' as type CALL dbms.procedures() yield name, description, signature " + filter +
                " UNION ALL " +
                "WITH 'function' as type CALL dbms.functions() yield name, description, signature " + filter;
        return db.execute(query, map("name", name, "desc", searchText ? name : null))
                .stream().map(HelpResult::new);
    }
}