org.neo4j.kernel.api.procedure.GlobalProcedures Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-kernel Show documentation

Neo4j kernel is a lightweight, embedded Java database designed to store data structured as graphs rather than tables. For more information, see http://neo4j.org.

There is a newer version: 5.25.1

Show newest version

/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.kernel.api.procedure;

import java.io.IOException;
import java.util.List;
import java.util.function.Predicate;
import org.neo4j.exceptions.KernelException;
import org.neo4j.function.ThrowingFunction;
import org.neo4j.graphdb.Transaction;
import org.neo4j.internal.kernel.api.exceptions.ProcedureException;
import org.neo4j.internal.kernel.api.procs.Neo4jTypes;
import org.neo4j.internal.kernel.api.procs.ProcedureSignature;
import org.neo4j.internal.kernel.api.procs.QualifiedName;
import org.neo4j.internal.kernel.api.procs.UserFunctionSignature;
import org.neo4j.util.VisibleForTesting;

public interface GlobalProcedures {
    void register(CallableProcedure proc) throws ProcedureException;

    void register(CallableUserFunction function) throws ProcedureException;

    void register(CallableUserAggregationFunction function) throws ProcedureException;

    void registerProcedure(Class proc) throws ProcedureException;

    void registerFunction(Class func) throws ProcedureException;

    void registerAggregationFunction(Class func) throws ProcedureException;

    void registerType(Class javaClass, Neo4jTypes.AnyType type);

     void registerComponent(Class cls, ThrowingFunction provider, boolean safe);

    ProcedureView getCurrentView();

    LoadInformation reloadProceduresFromDisk(Transaction tx, Predicate namespaceFilter)
            throws KernelException, IOException;

    @VisibleForTesting
    // Allow tests to unregister some procedures so far intended only for tests usages
    void unregister(QualifiedName name);

    record LoadInformation(
            List procedures,
            List functions,
            List aggregations) {}
}