org.neo4j.kernel.impl.query.QueryExecution 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.impl.query;

import org.neo4j.graphdb.ExecutionPlanDescription;
import org.neo4j.graphdb.Notification;
import org.neo4j.graphdb.QueryExecutionType;

/**
 * The execution of a query is a {@link QuerySubscription} with added methods describing the actual execution of a
 * query.
 */
public interface QueryExecution extends QuerySubscription {

    /**
     * Generally, execution type, plan and notifications are guaranteed to be available
     * only at the end of query execution when the result stream has been fully consumed.
     * They might be available sooner for which case this method should be used to check the availability.
     * Trying to get the metadata when they are not available will raise an exception.
     * Field names are available always.
     */
    default boolean executionMetadataAvailable() {
        return true;
    }
    /**
     * The {@link QueryExecutionType} of the query,
     */
    QueryExecutionType executionType();

    /**
     * @return The plan description of the query.
     */
    ExecutionPlanDescription executionPlanDescription();

    /**
     * @return all notifications and warnings of the query.
     */
    Iterable getNotifications();

    /**
     * The name of the fields of each record
     *
     * @return an array of the field names of each record.
     */
    String[] fieldNames();

    /**
     * Wait for a query execution that has ended or has been cancelled
     * to finish cleanup. This is to be called before closing the query result.
     * Depending on the runtime, cleaning up _could_ be an asynchronous operation.
     * If cleaning up is not an asynchronous operation this is a no-op.
     */
    default void awaitCleanup() {}
}