org.neo4j.jdbc.internal.bolt.response.SummaryCounters Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-jdbc Show documentation
Implementation of the Neo4j JDBC driver.
There is a newer version: 6.0.1
/*
 * Copyright (c) 2023-2024 "Neo4j,"
 * Neo4j Sweden AB [https://neo4j.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
 *
 *     https://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.jdbc.internal.bolt.response;

/**
 * Contains counters for various operations that a query triggered.
 *
 * @author Neo4j Drivers Team
 * @since 6.0.0
 */
public interface SummaryCounters {

	int totalCount();

	/**
	 * Whether there were any updates at all, eg. any of the counters are greater than 0.
	 * @return true if the query made any updates
	 */
	boolean containsUpdates();

	/**
	 * Returns the number of nodes created.
	 * @return number of nodes created.
	 */
	int nodesCreated();

	/**
	 * Returns the number of nodes deleted.
	 * @return number of nodes deleted.
	 */
	int nodesDeleted();

	/**
	 * Returns the number of relationships created.
	 * @return number of relationships created.
	 */
	int relationshipsCreated();

	/**
	 * Returns the number of relationships deleted.
	 * @return number of relationships deleted.
	 */
	int relationshipsDeleted();

	/**
	 * Returns the number of properties (on both nodes and relationships) set.
	 * @return number of properties (on both nodes and relationships) set.
	 */
	int propertiesSet();

	/**
	 * Returns the number of labels added to nodes.
	 * @return number of labels added to nodes.
	 */
	int labelsAdded();

	/**
	 * Returns the number of labels removed from nodes.
	 * @return number of labels removed from nodes.
	 */
	int labelsRemoved();

	/**
	 * Returns the number of indexes added to the schema.
	 * @return number of indexes added to the schema.
	 */
	int indexesAdded();

	/**
	 * Returns the number of indexes removed from the schema.
	 * @return number of indexes removed from the schema.
	 */
	int indexesRemoved();

	/**
	 * Returns the number of constraints added to the schema.
	 * @return number of constraints added to the schema.
	 */
	int constraintsAdded();

	/**
	 * Returns the number of constraints removed from the schema.
	 * @return number of constraints removed from the schema.
	 */
	int constraintsRemoved();

	/**
	 * If the query updated the system graph in any way, this method will return true.
	 * @return true if the system graph has been updated.
	 */
	boolean containsSystemUpdates();

	/**
	 * Returns the number of system updates performed by this query.
	 * @return the number of system updates performed by this query.
	 */
	int systemUpdates();

}