apoc.help.Help Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of apoc-core Show documentation
Core package for Neo4j Procedures
There is a newer version: 5.24.0
package apoc.help;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.stream.Stream;

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

import static apoc.util.Util.map;

public class Help {

    @Context
    public Transaction tx;

    private static final Set extended = new HashSet<>();

    public Help() {
        try (InputStream stream = getClass().getClassLoader().getResourceAsStream("extended.txt")) {
            if (stream != null) {
                BufferedReader reader = new BufferedReader(new InputStreamReader(stream));
                String name;
                while ((name = reader.readLine()) != null) {
                    extended.add(name);
                }
            }
        } catch (IOException e) {
            // Failed to load extended file
            throw new RuntimeException("Failed to load extended file with error: " + e.getMessage());
        }
    }

    @Procedure("apoc.help")
    @Description("Returns descriptions of the available APOC procedures and functions.")
    public Stream info(@Name("proc") String name) {
        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))) ";

        String proceduresQuery = "SHOW PROCEDURES yield name, description, signature " + filter +
                                 "RETURN 'procedure' as type, name, description, signature ";

        String functionsQuery = "SHOW FUNCTIONS yield name, description, signature " + filter +
                                "RETURN 'function' as type, name, description, signature ";
        Map params = map( "name", name, "desc", searchText ? name : null );
        Stream> proceduresResults = tx.execute( proceduresQuery, params ).stream();
        Stream> functionsResults = tx.execute( functionsQuery, params ).stream();

        return Stream.of( proceduresResults, functionsResults ).flatMap( results -> results.map(
                row -> new HelpResult( row, !extended.contains( (String) row.get( "name" ) ) ) ) );
    }
}