org.neo4j.driver.v1.StatementRunner 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
There is a newer version: 5.27.0
/**
 * Copyright (c) 2002-2016 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.com]
 *
 * This file is part of Neo4j.
 *
 * 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.v1;

import java.util.Map;

/**
 * Common interface for components that can execute Neo4j statements.
 *
 * @see Session
 * @see Transaction
 */
public interface StatementRunner
{
    /**
     * Run a statement and return a result stream.
     *
     * This method takes a set of parameters that will be injected into the
     * statement 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.
     *
     * Example
     *      * {@code
     * ResultCursor cursor = session.run( "MATCH (n) WHERE n.name = {myNameParam} RETURN (n)",
     *                                    Values.parameters( "myNameParam", "Bob" ) );
     * }
     * 
     *
     * @param statementTemplate template of a Neo4j statement
     * @param statementParameters input data for the statement, see {@link Values#parameters(Object...)}
     * @return a stream of result values and associated metadata
     */
    ResultCursor run( String statementTemplate, Map statementParameters );

    /**
     * Run a statement and return a result stream.
     *
     * @param statementTemplate template of a Neo4j statement
     * @return a stream of result values and associated metadata
     */
    ResultCursor run( String statementTemplate );

    /**
     * Run a statement and return a result stream.
     * Example
     *      * {@code
     * Statement statement = new Statement( "MATCH (n) WHERE n.name={myNameParam} RETURN n.age" );
     * ResultCursor cursor = session.run( statement.withParameters( Values.parameters( "myNameParam", "Bob" )  ) );
     * }
     * 
     *
     * @param statement a Neo4j statement
     * @return a stream of result values and associated metadata
     */
    ResultCursor run( Statement statement );

    /**
     * @return type system used by this statement runner for classifying values
     */
    @Experimental
    TypeSystem typeSystem();
}