org.neo4j.dbms.systemgraph.versions.KnownCommunityTopologyComponentVersion Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j Show documentation
Neo4j Community Edition
There is a newer version: 5.25.1
/*
 * 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.dbms.systemgraph.versions;


import org.neo4j.dbms.database.ComponentVersion;
import org.neo4j.dbms.database.KnownSystemComponentVersion;
import org.neo4j.dbms.systemgraph.TopologyGraphDbmsModel;
import org.neo4j.graphdb.Node;
import org.neo4j.graphdb.Relationship;
import org.neo4j.graphdb.ResourceIterator;
import org.neo4j.graphdb.Transaction;
import org.neo4j.internal.kernel.api.security.CommunitySecurityLog;

import static org.neo4j.dbms.systemgraph.TopologyGraphDbmsModel.DATABASE_ACCESS_PROPERTY;
import static org.neo4j.dbms.systemgraph.TopologyGraphDbmsModel.DATABASE_LABEL;
import static org.neo4j.dbms.systemgraph.TopologyGraphDbmsModel.DATABASE_NAME_LABEL;
import static org.neo4j.dbms.systemgraph.TopologyGraphDbmsModel.DATABASE_NAME_PROPERTY;
import static org.neo4j.dbms.systemgraph.TopologyGraphDbmsModel.NAME_PROPERTY;
import static org.neo4j.dbms.systemgraph.TopologyGraphDbmsModel.PRIMARY_PROPERTY;
import static org.neo4j.dbms.systemgraph.TopologyGraphDbmsModel.TARGETS_RELATIONSHIP;

public abstract class KnownCommunityTopologyComponentVersion extends KnownSystemComponentVersion
{
    KnownCommunityTopologyComponentVersion( ComponentVersion componentVersion )
    {
        // TODO we do not have access to the security log here should we send in the neo4j log instead?
        super( componentVersion, CommunitySecurityLog.NULL_LOG );
    }

    /**
     * Initialize the topology graph to this version.
     *
     * @param tx open transaction to perform the initialization in
     */
    public void initializeTopologyGraph( Transaction tx )
    {
        setDatabaseAccessToReadWrite( tx );
        addDatabaseNameNodes( tx );
    }

    /**
     * Set access property to read-write for all existing nodes
     *
     * @param tx open transaction to perform the method in
     */
    protected void setDatabaseAccessToReadWrite( Transaction tx )
    {
        final ResourceIterator nodes = tx.findNodes( DATABASE_LABEL );
        nodes.stream().forEach( node -> node.setProperty( DATABASE_ACCESS_PROPERTY, TopologyGraphDbmsModel.DatabaseAccess.READ_WRITE.toString() ) );
    }

    /**
     * Add DatabaseName nodes to Database nodes
     * (:Database)<-[:TARGETS]-(:DatabaseName)
     * @param tx open transaction to perform the method in
     */
    protected void addDatabaseNameNodes( Transaction tx )
    {
        final ResourceIterator nodes = tx.findNodes( DATABASE_LABEL );
        nodes.stream().forEach(
                databaseNode ->
                {
                    if ( !hasPrimaryAlias( databaseNode ) )
                    {
                        Node nameNode = tx.createNode( DATABASE_NAME_LABEL );
                        nameNode.setProperty( NAME_PROPERTY, databaseNode.getProperty( DATABASE_NAME_PROPERTY ) );
                        nameNode.setProperty( PRIMARY_PROPERTY, true );
                        nameNode.createRelationshipTo( databaseNode, TARGETS_RELATIONSHIP );
                    }
                }
        );
    }

    private boolean hasPrimaryAlias( Node node )
    {
        boolean hasPrimary = false;

        for ( Relationship relationship : node.getRelationships( TARGETS_RELATIONSHIP ) )
        {
            Node nameNode = relationship.getStartNode();
            if ( nameNode.getProperty( PRIMARY_PROPERTY ).equals( true ) )
            {
                hasPrimary = true;
            }
        }

        return hasPrimary;
    }

    /**
     * Upgrade the topology graph to this version.
     * This method recursively calls older versions and performs the upgrades in steps.
     *
     * @param tx open transaction to perform the upgrade in
     * @param fromVersion the detected version, upgrade will be performed rolling from this
     */
    public abstract void upgradeTopologyGraph( Transaction tx, int fromVersion ) throws Exception;
}