org.neo4j.kernel.impl.api.ExecutingQueryFactory 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 [http://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.api;

import java.util.Map;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicReference;

import org.neo4j.configuration.Config;
import org.neo4j.configuration.GraphDatabaseSettings;
import org.neo4j.configuration.SettingChangeListener;
import org.neo4j.internal.kernel.api.connectioninfo.ClientConnectionInfo;
import org.neo4j.kernel.api.query.ExecutingQuery;
import org.neo4j.kernel.impl.util.MonotonicCounter;
import org.neo4j.resources.CpuClock;
import org.neo4j.time.SystemNanoClock;
import org.neo4j.values.virtual.MapValue;

public class ExecutingQueryFactory
{
    private static final MonotonicCounter lastQueryId = MonotonicCounter.newAtomicMonotonicCounter();
    private final SystemNanoClock clock;
    private final AtomicReference cpuClockRef;
    private final AtomicBoolean trackQueryAllocations;
    private final SettingChangeListener configListener;
    private final Config config;

    public ExecutingQueryFactory( SystemNanoClock clock, AtomicReference cpuClockRef, Config config )
    {
        this.clock = clock;
        this.cpuClockRef = cpuClockRef;
        this.trackQueryAllocations = new AtomicBoolean( config.get( GraphDatabaseSettings.track_query_allocation ) );
        this.configListener = ( before, after ) -> trackQueryAllocations.set( after );
        this.config = config;
        config.addListener( GraphDatabaseSettings.track_query_allocation, configListener );
    }

    public ExecutingQuery createForStatement( KernelStatement statement, String queryText, MapValue queryParameters )
    {
        KernelTransactionImplementation transaction = statement.getTransaction();
        ExecutingQuery executingQuery = createUnbound( queryText,
                                                       queryParameters,
                                                       transaction.clientInfo(),
                                                       statement.executingUser(),
                                                       statement.authenticatedUser(),
                                                       transaction.getMetaData() );
        bindToStatement( executingQuery, statement );
        return executingQuery;
    }

    public ExecutingQuery createUnbound( String queryText, MapValue queryParameters,
                                         ClientConnectionInfo clientConnectionInfo, String executingUser, String authenticatedUser,
                                         Map transactionMetaData )
    {
        Thread thread = Thread.currentThread();
        return new ExecutingQuery(
                lastQueryId.incrementAndGet(),
                clientConnectionInfo,
                executingUser,
                authenticatedUser,
                queryText,
                queryParameters,
                transactionMetaData,
                thread.getId(),
                thread.getName(),
                clock,
                cpuClockRef.get(),
                trackQueryAllocations.get() );
    }

    public static void bindToStatement( ExecutingQuery executingQuery, KernelStatement statement )
    {
        executingQuery.onTransactionBound( new ExecutingQuery.TransactionBinding(
                statement.namedDatabaseId(),
                statement::getHits,
                statement::getFaults,
                () -> statement.locks().activeLockCount(),
                statement.getTransaction().getUserTransactionId()
        ) );
    }

    public static void unbindFromTransaction( ExecutingQuery executingQuery, long userTransactionId )
    {
        executingQuery.onTransactionUnbound( userTransactionId );
    }

    public void dispose()
    {
        config.removeListener( GraphDatabaseSettings.track_query_allocation, configListener );
    }
}