org.neo4j.kernel.impl.factory.GraphDatabaseTransactions 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.factory;

import static java.util.Collections.emptyMap;
import static java.util.Objects.requireNonNull;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
import static org.neo4j.configuration.GraphDatabaseSettings.transaction_timeout;
import static org.neo4j.graphdb.ResultTransformer.EMPTY_TRANSFORMER;
import static org.neo4j.internal.kernel.api.connectioninfo.ClientConnectionInfo.EMBEDDED_CONNECTION;
import static org.neo4j.internal.kernel.api.security.LoginContext.AUTH_DISABLED;

import java.time.Duration;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import org.neo4j.configuration.Config;
import org.neo4j.graphdb.QueryExecutionException;
import org.neo4j.graphdb.ResultTransformer;
import org.neo4j.graphdb.Transaction;
import org.neo4j.internal.kernel.api.connectioninfo.ClientConnectionInfo;
import org.neo4j.internal.kernel.api.security.LoginContext;
import org.neo4j.kernel.api.KernelTransaction;
import org.neo4j.kernel.impl.coreapi.InternalTransaction;
import org.neo4j.kernel.internal.GraphDatabaseAPI;

/**
 * Implements all special versions of "begin" (beginTx, beginTransaction, executeTransactionally)
 * by delegating to a single abstract beginTransaction()
 */
public abstract class GraphDatabaseTransactions implements GraphDatabaseAPI {

    private final Config config;

    protected GraphDatabaseTransactions(Config config) {
        this.config = requireNonNull(config);
    }

    @Override
    public void executeTransactionally(String query) throws QueryExecutionException {
        executeTransactionally(query, emptyMap(), EMPTY_TRANSFORMER);
    }

    @Override
    public void executeTransactionally(String query, Map parameters) throws QueryExecutionException {
        executeTransactionally(query, parameters, EMPTY_TRANSFORMER);
    }

    @Override
    public  T executeTransactionally(
            String query, Map parameters, ResultTransformer resultTransformer)
            throws QueryExecutionException {
        return executeTransactionally(query, parameters, resultTransformer, defaultTransactionTimeout());
    }

    @Override
    public  T executeTransactionally(
            String query, Map parameters, ResultTransformer resultTransformer, Duration timeout)
            throws QueryExecutionException {
        T transformedResult;
        try (var internalTransaction = beginTransaction(
                KernelTransaction.Type.IMPLICIT,
                AUTH_DISABLED,
                EMBEDDED_CONNECTION,
                timeout.toMillis(),
                MILLISECONDS)) {
            try (var result = internalTransaction.execute(query, parameters)) {
                transformedResult = resultTransformer.apply(result);
            }
            internalTransaction.commit();
        }
        return transformedResult;
    }

    @Override
    public Transaction beginTx() {
        return beginTransaction();
    }

    @Override
    public Transaction beginTx(long timeout, TimeUnit unit) {
        return beginTransaction(KernelTransaction.Type.EXPLICIT, AUTH_DISABLED, EMBEDDED_CONNECTION, timeout, unit);
    }

    protected InternalTransaction beginTransaction() {
        return beginTransaction(KernelTransaction.Type.EXPLICIT, AUTH_DISABLED);
    }

    @Override
    public InternalTransaction beginTransaction(KernelTransaction.Type type, LoginContext loginContext) {
        return beginTransaction(type, loginContext, EMBEDDED_CONNECTION);
    }

    @Override
    public InternalTransaction beginTransaction(
            KernelTransaction.Type type, LoginContext loginContext, ClientConnectionInfo clientInfo) {
        return beginTransaction(
                type, loginContext, clientInfo, defaultTransactionTimeout().toMillis(), MILLISECONDS);
    }

    @Override
    public abstract InternalTransaction beginTransaction(
            KernelTransaction.Type type,
            LoginContext loginContext,
            ClientConnectionInfo clientInfo,
            long timeout,
            TimeUnit unit);

    protected Duration defaultTransactionTimeout() {
        return config.get(transaction_timeout);
    }
}