org.neo4j.kernel.impl.index.ExplicitIndexStore Maven / Gradle / Ivy
/*
* Copyright (c) 2018-2020 "Graph Foundation,"
* Graph Foundation, Inc. [https://graphfoundation.org]
*
* This file is part of ONgDB.
*
* ONgDB 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 indexProviders;
private final Supplier kernel;
public ExplicitIndexStore( @Nonnull Config config, IndexConfigStore indexStore, Supplier kernel,
Function indexProviders )
{
this.config = config;
this.indexStore = indexStore;
this.kernel = kernel;
this.indexProviders = indexProviders;
}
public Map getOrCreateNodeIndexConfig( String indexName, Map customConfiguration )
{
return getOrCreateIndexConfig( IndexEntityType.Node, indexName, customConfiguration );
}
public Map getOrCreateRelationshipIndexConfig( String indexName,
Map customConfiguration )
{
return getOrCreateIndexConfig( IndexEntityType.Relationship, indexName, customConfiguration );
}
private Map findIndexConfig(
Class cls, String indexName,
Map suppliedConfig, @Nonnull Config dbConfig )
{
// Check stored config (has this index been created previously?)
Map storedConfig = indexStore.get( cls, indexName );
if ( storedConfig != null && suppliedConfig == null )
{
// Fill in "provider" if not already filled in, backwards compatibility issue
Map newConfig = injectDefaultProviderIfMissing( indexName, dbConfig, storedConfig );
if ( newConfig != storedConfig )
{
indexStore.set( cls, indexName, newConfig );
}
return newConfig;
}
Map configToUse = suppliedConfig;
// Check db config properties for provider
String provider;
IndexImplementation indexProvider;
if ( configToUse == null )
{
provider = getDefaultProvider( indexName, dbConfig );
configToUse = MapUtil.stringMap( PROVIDER, provider );
}
else
{
provider = configToUse.get( PROVIDER );
provider = provider == null ? getDefaultProvider( indexName, dbConfig ) : provider;
}
indexProvider = indexProviders.apply( provider );
configToUse = indexProvider.fillInDefaults( configToUse );
configToUse = injectDefaultProviderIfMissing( indexName, dbConfig, configToUse );
// Do they match (stored vs. supplied)?
if ( storedConfig != null )
{
assertConfigMatches( indexProvider, indexName, storedConfig, suppliedConfig );
// Fill in "provider" if not already filled in, backwards compatibility issue
Map newConfig = injectDefaultProviderIfMissing( indexName, dbConfig, storedConfig );
if ( newConfig != storedConfig )
{
indexStore.set( cls, indexName, newConfig );
}
configToUse = newConfig;
}
return Collections.unmodifiableMap( configToUse );
}
public static void assertConfigMatches( IndexImplementation indexProvider, String indexName,
Map storedConfig, Map suppliedConfig )
{
if ( suppliedConfig != null && !indexProvider.configMatches( storedConfig, suppliedConfig ) )
{
throw new IllegalArgumentException( "Supplied index configuration:\n" +
suppliedConfig + "\ndoesn't match stored config in a valid way:\n" + storedConfig +
"\nfor '" + indexName + "'" );
}
}
@Nonnull
private Map injectDefaultProviderIfMissing( @Nullable String indexName, @Nonnull Config dbConfig,
@Nonnull Map config )
{
String provider = config.get( PROVIDER );
if ( provider == null )
{
config = new HashMap<>( config );
config.put( PROVIDER, getDefaultProvider( indexName, dbConfig ) );
}
return config;
}
@Nonnull
private String getDefaultProvider( @Nullable String indexName, @Nonnull Config dbConfig )
{
return dbConfig.getRaw( "index." + indexName )
.orElseGet( () -> dbConfig.getRaw( "index" ).orElse( "lucene" ) );
}
private Map getOrCreateIndexConfig(
IndexEntityType entityType, String indexName, Map suppliedConfig )
{
Map config = findIndexConfig(
entityType.entityClass(), indexName, suppliedConfig, this.config );
if ( !indexStore.has( entityType.entityClass(), indexName ) )
{ // Ok, we need to create this config
synchronized ( this )
{ // Were we the first ones to get here?
Map existing = indexStore.get( entityType.entityClass(), indexName );
if ( existing != null )
{
// No, someone else made it before us, cool
assertConfigMatches(
indexProviders.apply( existing.get( PROVIDER ) ), indexName, existing, config );
return config;
}
// We were the first one here, let's create this config
try ( Session session = kernel.get().beginSession( AUTH_DISABLED );
Transaction transaction = session.beginTransaction( Transaction.Type.implicit );
Statement statement = ((KernelTransaction)transaction).acquireStatement() )
{
switch ( entityType )
{
case Node:
transaction.indexWrite().nodeExplicitIndexCreate( indexName, config );
break;
case Relationship:
transaction.indexWrite().relationshipExplicitIndexCreate( indexName, config );
break;
default:
throw new IllegalArgumentException( "Unknown entity type: " + entityType );
}
transaction.success();
}
catch ( Exception ex )
{
throw new TransactionFailureException(
"Index creation failed for " + indexName + ", " + config, ex );
}
}
}
return config;
}
public String setNodeIndexConfiguration( String indexName, String key, String value )
throws ExplicitIndexNotFoundKernelException
{
assertLegalConfigKey( key );
Map config = new HashMap<>( getNodeIndexConfiguration( indexName ) );
String oldValue = config.put( key, value );
indexStore.set( Node.class, indexName, config );
return oldValue;
}
public String setRelationshipIndexConfiguration( String indexName, String key, String value )
throws ExplicitIndexNotFoundKernelException
{
assertLegalConfigKey( key );
Map config = new HashMap<>( getRelationshipIndexConfiguration( indexName ) );
String oldValue = config.put( key, value );
indexStore.set( Relationship.class, indexName, config );
return oldValue;
}
public String removeNodeIndexConfiguration( String indexName, String key )
throws ExplicitIndexNotFoundKernelException
{
assertLegalConfigKey( key );
Map config = new HashMap<>( getNodeIndexConfiguration( indexName ) );
String value = config.remove( key );
if ( value != null )
{
indexStore.set( Node.class, indexName, config );
}
return value;
}
public String removeRelationshipIndexConfiguration( String indexName, String key )
throws ExplicitIndexNotFoundKernelException
{
assertLegalConfigKey( key );
Map config = new HashMap<>( getRelationshipIndexConfiguration( indexName ) );
String value = config.remove( key );
if ( value != null )
{
indexStore.set( Relationship.class, indexName, config );
}
return value;
}
public Map getNodeIndexConfiguration( String indexName ) throws ExplicitIndexNotFoundKernelException
{
Map config = indexStore.get( Node.class, indexName );
if ( config == null )
{
throw new ExplicitIndexNotFoundKernelException( "No node index '" + indexName + "' found" );
}
return config;
}
public Map getRelationshipIndexConfiguration( String indexName )
throws ExplicitIndexNotFoundKernelException
{
Map config = indexStore.get( Relationship.class, indexName );
if ( config == null )
{
throw new ExplicitIndexNotFoundKernelException( "No relationship index '" + indexName + "' found" );
}
return config;
}
private void assertLegalConfigKey( String key )
{
if ( key.equals( PROVIDER ) )
{
throw new IllegalArgumentException( "'" + key + "' cannot be modified" );
}
}
public String[] getAllNodeIndexNames()
{
return indexStore.getNames( Node.class );
}
public String[] getAllRelationshipIndexNames()
{
return indexStore.getNames( Relationship.class );
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy