org.neo4j.driver.reactivestreams.ReactiveQueryRunner Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-java-driver Show documentation
Access to the Neo4j graph database through Java
The newest version!
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.neo4j.driver.reactivestreams;

import java.util.Map;
import org.neo4j.driver.Query;
import org.neo4j.driver.Record;
import org.neo4j.driver.Value;
import org.neo4j.driver.Values;
import org.reactivestreams.Publisher;

/**
 * Common interface for components that can execute Neo4j queries using Reactive API.
 *
 * @see ReactiveSession
 * @see ReactiveTransaction
 * @since 5.2
 */
public interface ReactiveQueryRunner {
    /**
     * Register running of a query and return a publisher of {@link ReactiveResult}.
     * 
     * Invoking this method will result in a Bolt RUN message exchange with server and the returned publisher will either emit an instance of {@link
     * ReactiveResult} on success or an error otherwise.
     * 

     * This method takes a set of parameters that will be injected into the query by Neo4j. Using parameters is highly encouraged, it helps avoid dangerous
     * cypher injection attacks and improves database performance as Neo4j can re-use query plans more often.
     * 

     * This particular method takes a {@link Value} as its input. This is useful if you want to take a map-like value that you've gotten from a prior result and
     * send it back as parameters.
     * 

     * If you are creating parameters programmatically, {@link #run(String, Map)} might be more helpful, it converts your map to a {@link Value} for you.
     *
     * @param query      text of a Neo4j query
     * @param parameters input parameters, should be a map Value, see {@link Values#parameters(Object...)}.
     * @return a publisher of reactive result.
     */
    Publisher run(String query, Value parameters);

    /**
     * Register running of a query and return a publisher of {@link ReactiveResult}.
     * 

     * Invoking this method will result in a Bolt RUN message exchange with server and the returned publisher will either emit an instance of {@link
     * ReactiveResult} on success or an error otherwise.
     * 

     * This method takes a set of parameters that will be injected into the query by Neo4j. Using parameters is highly encouraged, it helps avoid dangerous
     * cypher injection attacks and improves database performance as Neo4j can re-use query plans more often.
     * 

     * This version of run takes a {@link Map} of parameters. The values in the map must be values that can be converted to Neo4j types. See {@link
     * Values#parameters(Object...)} for a list of allowed types.
     *
     * @param query      text of a Neo4j query
     * @param parameters input data for the query
     * @return a publisher of reactive result.
     */
    Publisher run(String query, Map parameters);

    /**
     * Register running of a query and return a publisher of {@link ReactiveResult}.
     * 

     * Invoking this method will result in a Bolt RUN message exchange with server and the returned publisher will either emit an instance of {@link
     * ReactiveResult} on success or an error otherwise.
     * 

     * This method takes a set of parameters that will be injected into the query by Neo4j. Using parameters is highly encouraged, it helps avoid dangerous
     * cypher injection attacks and improves database performance as Neo4j can re-use query plans more often.
     * 

     * This version of run takes a {@link Record} of parameters, which can be useful if you want to use the output of one query as input for another.
     *
     * @param query      text of a Neo4j query
     * @param parameters input data for the query
     * @return a publisher of reactive result.
     */
    Publisher run(String query, Record parameters);

    /**
     * Register running of a query and return a publisher of {@link ReactiveResult}.
     * 

     * Invoking this method will result in a Bolt RUN message exchange with server and the returned publisher will either emit an instance of {@link
     * ReactiveResult} on success or an error otherwise.
     *
     * @param query text of a Neo4j query
     * @return a publisher of reactive result.
     */
    Publisher run(String query);

    /**
     * Register running of a query and return a publisher of {@link ReactiveResult}.
     * 
     * Invoking this method will result in a Bolt RUN message exchange with server and the returned publisher will either emit an instance of {@link
     * ReactiveResult} on success or an error otherwise.
     *
     * @param query a Neo4j query
     * @return a publisher of reactive result.
     */
    Publisher run(Query query);
}