org.neo4j.jdbc.Neo4jConnection 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;

import java.sql.Connection;
import java.sql.SQLException;
import java.util.concurrent.Executor;

/**
 * A Neo4j specific extension of {@link Connection}. It may be referred to for use with
 * {@link #unwrap(Class)} to access specific Neo4j functionality.
 *
 * @author Michael J. Simons
 * @since 6.0.0
 */
public sealed interface Neo4jConnection extends Connection, Neo4jMetadataWriter permits ConnectionImpl {

	/**
	 * Sets the timeout for which a connection may remain idle following a request.
	 * 
	 * The timeout value applies to individual server responses, not the JDBC API calls.
	 * Any response from the server, including the {@literal NOOP} chunk, interrupts the
	 * idle period.
	 * 

	 * When initializing a new Bolt connection, the Neo4j server may supply a
	 * {@literal connection.recv_timeout_seconds} connection hint that defines the amount
	 * of time for which the connection may remain idle (see the linked documentation for
	 * more details). When the network timeout value is set to {@literal 0} and the hint
	 * value is available, the latter is used as a default.
	 * 

	 * For method full description, see the
	 * {@link Connection#setNetworkTimeout(Executor, int)} documentation.
	 * @param executor this parameter is not used by this implementation and may be
	 * {@literal null}.
	 * @param milliseconds the timeout value in milliseconds. If the value is
	 * {@literal 0}, the connection hint value is used providing it was supplied by the
	 * server or the timeout is turned off.
	 * @throws SQLException if a database access error occurs, this method is called on a
	 * closed connection or the value specified for seconds is less than 0.
	 * @see connection.recv_timeout_seconds
	 * connection hint
	 */
	@Override
	void setNetworkTimeout(Executor executor, int milliseconds) throws SQLException;

	/**
	 * Returns the network timeout value.
	 * 
	 * For method full description, see the {@link Connection#getNetworkTimeout()}
	 * documentation.
	 * @return the timeout value. The value {@literal 0} means the server supplied timeout
	 * is used when available or the timeout is off.
	 * @throws SQLException if a database access error occurs or this method is called on
	 * a closed connection.
	 * @see connection.recv_timeout_seconds
	 * connection hint
	 */
	@Override
	int getNetworkTimeout() throws SQLException;

	/**
	 * Flushes the SQL to Cypher translation cache.
	 */
	void flushTranslationCache();

	/**
	 * Returns the name of the database for this connection.
	 * @return the name of the database for this connection
	 */
	String getDatabaseName();

}