Please wait. This can take some minutes ...
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.neo4j.kernel.api.impl.fulltext.FulltextIndexProvider Maven / Gradle / Ivy
/*
* 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.api.impl.fulltext;
import org.apache.commons.lang3.StringUtils;
import org.apache.lucene.analysis.Analyzer;
import java.io.IOException;
import java.util.Objects;
import java.util.Optional;
import java.util.stream.Stream;
import org.neo4j.common.TokenNameLookup;
import org.neo4j.configuration.Config;
import org.neo4j.configuration.FulltextSettings;
import org.neo4j.dbms.database.readonly.DatabaseReadOnlyChecker;
import org.neo4j.graphdb.schema.AnalyzerProvider;
import org.neo4j.internal.helpers.Exceptions;
import org.neo4j.internal.kernel.api.InternalIndexState;
import org.neo4j.internal.schema.IndexCapability;
import org.neo4j.internal.schema.IndexConfig;
import org.neo4j.internal.schema.IndexDescriptor;
import org.neo4j.internal.schema.IndexPrototype;
import org.neo4j.internal.schema.IndexProviderDescriptor;
import org.neo4j.internal.schema.IndexRef;
import org.neo4j.internal.schema.IndexType;
import org.neo4j.io.fs.FileSystemAbstraction;
import org.neo4j.io.memory.ByteBufferFactory;
import org.neo4j.io.pagecache.PageCache;
import org.neo4j.io.pagecache.context.CursorContext;
import org.neo4j.kernel.api.impl.index.DatabaseIndex;
import org.neo4j.kernel.api.impl.index.DroppableIndex;
import org.neo4j.kernel.api.impl.index.DroppableLuceneIndex;
import org.neo4j.kernel.api.impl.index.LuceneMinimalIndexAccessor;
import org.neo4j.kernel.api.impl.index.partition.ReadOnlyIndexPartitionFactory;
import org.neo4j.kernel.api.impl.index.storage.DirectoryFactory;
import org.neo4j.kernel.api.impl.index.storage.IndexStorageFactory;
import org.neo4j.kernel.api.impl.index.storage.PartitionedIndexStorage;
import org.neo4j.kernel.api.impl.schema.LuceneSchemaIndexBuilder;
import org.neo4j.kernel.api.impl.schema.SchemaIndex;
import org.neo4j.kernel.api.index.IndexAccessor;
import org.neo4j.kernel.api.index.IndexDirectoryStructure;
import org.neo4j.kernel.api.index.IndexPopulator;
import org.neo4j.kernel.api.index.IndexProvider;
import org.neo4j.kernel.api.index.MinimalIndexAccessor;
import org.neo4j.kernel.impl.api.index.IndexSamplingConfig;
import org.neo4j.kernel.impl.index.schema.IndexUpdateIgnoreStrategy;
import org.neo4j.logging.Log;
import org.neo4j.memory.MemoryTracker;
import org.neo4j.scheduler.JobScheduler;
import org.neo4j.service.Services;
import org.neo4j.storageengine.api.StorageEngineFactory;
import org.neo4j.storageengine.migration.SchemaIndexMigrator;
import org.neo4j.storageengine.migration.StoreMigrationParticipant;
import org.neo4j.token.TokenHolders;
import org.neo4j.token.api.NamedToken;
import org.neo4j.token.api.TokenHolder;
import org.neo4j.token.api.TokenNotFoundException;
import org.neo4j.values.storable.TextValue;
import org.neo4j.values.storable.Value;
import org.neo4j.values.storable.ValueCategory;
import org.neo4j.values.storable.ValueGroup;
import org.neo4j.values.storable.Values;
import static org.apache.commons.lang3.StringUtils.defaultIfEmpty;
import static org.neo4j.kernel.api.impl.fulltext.FulltextIndexSettings.createAnalyzer;
import static org.neo4j.kernel.api.impl.fulltext.FulltextIndexSettings.createPropertyNames;
import static org.neo4j.kernel.api.impl.fulltext.FulltextIndexSettings.isEventuallyConsistent;
import static org.neo4j.kernel.api.impl.fulltext.FulltextIndexSettingsKeys.ANALYZER;
public class FulltextIndexProvider extends IndexProvider
{
public static final IndexUpdateIgnoreStrategy UPDATE_IGNORE_STRATEGY = values ->
{
for ( final var value : values )
{
if ( value != null && value.valueGroup().category() == ValueCategory.TEXT )
{
return false;
}
}
return true;
};
private final FileSystemAbstraction fileSystem;
private final Config config;
private final TokenHolders tokenHolders;
private final String defaultAnalyzerName;
private final boolean defaultEventuallyConsistentSetting;
private final DatabaseReadOnlyChecker readOnlyChecker;
private final Log log;
private final IndexUpdateSink indexUpdateSink;
private final IndexStorageFactory indexStorageFactory;
public FulltextIndexProvider( IndexProviderDescriptor descriptor, IndexDirectoryStructure.Factory directoryStructureFactory,
FileSystemAbstraction fileSystem, Config config, TokenHolders tokenHolders, DirectoryFactory directoryFactory,
DatabaseReadOnlyChecker readOnlyChecker, JobScheduler scheduler, Log log )
{
super( descriptor, directoryStructureFactory );
this.fileSystem = fileSystem;
this.config = config;
this.tokenHolders = tokenHolders;
this.readOnlyChecker = readOnlyChecker;
this.log = log;
defaultAnalyzerName = config.get( FulltextSettings.fulltext_default_analyzer );
defaultEventuallyConsistentSetting = config.get( FulltextSettings.eventually_consistent );
indexUpdateSink = new IndexUpdateSink( scheduler, config.get( FulltextSettings.eventually_consistent_index_update_queue_max_length ) );
indexStorageFactory = buildIndexStorageFactory( fileSystem, directoryFactory, directoryStructure() );
}
private static IndexStorageFactory buildIndexStorageFactory( FileSystemAbstraction fileSystem, DirectoryFactory directoryFactory,
IndexDirectoryStructure structure )
{
return new IndexStorageFactory( directoryFactory, fileSystem, structure );
}
private boolean indexIsOnline( PartitionedIndexStorage indexStorage, IndexDescriptor descriptor ) throws IOException
{
try ( SchemaIndex index = LuceneSchemaIndexBuilder.create( descriptor, readOnlyChecker, config ).withIndexStorage( indexStorage ).build() )
{
if ( index.exists() )
{
index.open();
return index.isOnline();
}
return false;
}
}
private PartitionedIndexStorage getIndexStorage( long indexId )
{
return indexStorageFactory.indexStorageOf( indexId );
}
@Override
public void shutdown() throws Exception
{
// Closing the index storage factory also closes all Lucene Directory instances.
// This has to be done at shutdown, which happens after all of the index accessors have been closed, and thus committed any pent up changes.
indexStorageFactory.close();
}
@Override
public IndexDescriptor completeConfiguration( IndexDescriptor index )
{
IndexConfig indexConfig = index.getIndexConfig();
indexConfig = addMissingDefaultIndexConfig( indexConfig );
index = index.withIndexConfig( indexConfig );
if ( index.getCapability().equals( IndexCapability.NO_CAPABILITY ) )
{
index = index.withIndexCapability( getCapability( index ) );
}
return index;
}
private static IndexCapability getCapability( IndexDescriptor index )
{
return new FulltextIndexCapability( isEventuallyConsistent( index ) );
}
@Override
public String getPopulationFailure( IndexDescriptor descriptor, CursorContext cursorContext )
{
return defaultIfEmpty( getIndexStorage( descriptor.getId() ).getStoredIndexFailure(), StringUtils.EMPTY );
}
@Override
public InternalIndexState getInitialState( IndexDescriptor index, CursorContext cursorContext )
{
PartitionedIndexStorage indexStorage = getIndexStorage( index.getId() );
String failure = indexStorage.getStoredIndexFailure();
if ( failure != null )
{
return InternalIndexState.FAILED;
}
// Verify that the index configuration is still valid.
// For instance, that it doesn't refer to an analyzer that has since been removed.
try
{
validateIndexRef( index );
}
catch ( Exception e )
{
try
{
indexStorage.storeIndexFailure( Exceptions.stringify( e ) );
}
catch ( IOException ex )
{
ex.addSuppressed( e );
log.warn( "Failed to persist index failure. Index failure added as suppressed exception.", ex );
}
return InternalIndexState.FAILED;
}
try
{
return indexIsOnline( indexStorage, index ) ? InternalIndexState.ONLINE : InternalIndexState.POPULATING;
}
catch ( IOException e )
{
return InternalIndexState.POPULATING;
}
}
@Override
public MinimalIndexAccessor getMinimalIndexAccessor( IndexDescriptor descriptor )
{
PartitionedIndexStorage indexStorage = getIndexStorage( descriptor.getId() );
DatabaseIndex fulltextIndex = new DroppableIndex<>(
new DroppableLuceneIndex<>( indexStorage, new ReadOnlyIndexPartitionFactory(), descriptor ) );
log.debug( "Creating dropper for fulltext schema index: %s", descriptor );
return new LuceneMinimalIndexAccessor<>( descriptor, fulltextIndex, isReadOnly() );
}
private boolean isReadOnly()
{
return readOnlyChecker.isReadOnly();
}
@Override
public IndexPopulator getPopulator( IndexDescriptor descriptor, IndexSamplingConfig samplingConfig,
ByteBufferFactory bufferFactory, MemoryTracker memoryTracker, TokenNameLookup tokenNameLookup )
{
if ( isReadOnly() )
{
throw new UnsupportedOperationException( "Can't create populator for read only index" );
}
try
{
PartitionedIndexStorage indexStorage = getIndexStorage( descriptor.getId() );
Analyzer analyzer = createAnalyzer( descriptor, tokenNameLookup );
String[] propertyNames = createPropertyNames( descriptor, tokenNameLookup );
DatabaseIndex fulltextIndex = FulltextIndexBuilder
.create( descriptor, config, readOnlyChecker, tokenHolders.propertyKeyTokens(), analyzer, propertyNames )
.withFileSystem( fileSystem )
.withIndexStorage( indexStorage )
.withPopulatingMode( true )
.build();
log.debug( "Creating populator for fulltext schema index: %s", descriptor );
return new FulltextIndexPopulator( descriptor, fulltextIndex, propertyNames, UPDATE_IGNORE_STRATEGY );
}
catch ( Exception e )
{
PartitionedIndexStorage indexStorage = getIndexStorage( descriptor.getId() );
DatabaseIndex fulltextIndex = new DroppableIndex<>(
new DroppableLuceneIndex<>( indexStorage, new ReadOnlyIndexPartitionFactory(), descriptor ) );
log.debug( "Creating failed index populator for fulltext schema index: %s", descriptor, e );
return new FailedFulltextIndexPopulator( descriptor, fulltextIndex, e );
}
}
@Override
public IndexAccessor getOnlineAccessor( IndexDescriptor index, IndexSamplingConfig samplingConfig, TokenNameLookup tokenNameLookup ) throws IOException
{
PartitionedIndexStorage indexStorage = getIndexStorage( index.getId() );
Analyzer analyzer = createAnalyzer( index, tokenHolders );
String[] propertyNames = createPropertyNames( index, tokenHolders );
FulltextIndexBuilder fulltextIndexBuilder = FulltextIndexBuilder
.create( index, config, readOnlyChecker, tokenHolders.propertyKeyTokens(), analyzer, propertyNames )
.withFileSystem( fileSystem )
.withIndexStorage( indexStorage )
.withPopulatingMode( false );
if ( isEventuallyConsistent( index ) )
{
fulltextIndexBuilder = fulltextIndexBuilder.withIndexUpdateSink( indexUpdateSink );
}
DatabaseIndex fulltextIndex = fulltextIndexBuilder.build();
fulltextIndex.open();
FulltextIndexAccessor accessor = new FulltextIndexAccessor( indexUpdateSink, fulltextIndex, index, propertyNames, UPDATE_IGNORE_STRATEGY );
log.debug( "Created online accessor for fulltext schema index %s: %s", index, accessor );
return accessor;
}
@Override
public StoreMigrationParticipant storeMigrationParticipant( final FileSystemAbstraction fs, PageCache pageCache, StorageEngineFactory storageEngineFactory )
{
return new SchemaIndexMigrator( "Fulltext indexes", fs, pageCache, this.directoryStructure(), storageEngineFactory, true );
}
@Override
public void validatePrototype( IndexPrototype prototype )
{
validateIndexRef( prototype );
}
@Override
public IndexType getIndexType()
{
return IndexType.FULLTEXT;
}
private void validateIndexRef( IndexRef> ref )
{
String providerName = getProviderDescriptor().name();
if ( ref.getIndexType() != IndexType.FULLTEXT )
{
throw new IllegalArgumentException( "The '" + providerName + "' index provider only supports FULLTEXT index types: " + ref );
}
if ( !ref.schema().isFulltextSchemaDescriptor() )
{
throw new IllegalArgumentException( "The " + ref.schema() + " index schema is not a full-text index schema, " +
"which it is required to be for the '" + providerName + "' index provider to be able to create an index." );
}
Value value = ref.getIndexConfig().get( ANALYZER );
if ( value != null )
{
if ( value.valueGroup() == ValueGroup.TEXT )
{
String analyzerName = ((TextValue) value).stringValue();
Optional analyzerProvider = listAvailableAnalyzers()
.filter( analyzer -> analyzer.getName().equals( analyzerName ) )
.findFirst();
if ( analyzerProvider.isPresent() )
{
// Verify that the analyzer provider works.
Analyzer analyzer = analyzerProvider.get().createAnalyzer();
Objects.requireNonNull( analyzer, "The '" + analyzerName + "' analyzer returned a 'null' analyzer." );
}
else
{
throw new IllegalArgumentException( "No such full-text analyzer: '" + analyzerName + "'." );
}
}
else
{
throw new IllegalArgumentException( "Wrong index setting value type for fulltext analyzer: '" + value + "'." );
}
}
TokenHolder propertyKeyTokens = tokenHolders.propertyKeyTokens();
for ( int propertyId : ref.schema().getPropertyIds() )
{
try
{
NamedToken token = propertyKeyTokens.getTokenById( propertyId );
if ( token.name().equals( LuceneFulltextDocumentStructure.FIELD_ENTITY_ID ) )
{
throw new IllegalArgumentException( "Unable to index the property, the name is reserved for internal use " +
LuceneFulltextDocumentStructure.FIELD_ENTITY_ID );
}
}
catch ( TokenNotFoundException e )
{
throw new IllegalArgumentException( "Schema references non-existing property key token id: " + propertyId + ".", e );
}
}
}
private IndexConfig addMissingDefaultIndexConfig( IndexConfig indexConfig )
{
indexConfig = indexConfig.withIfAbsent( ANALYZER, Values.stringValue( defaultAnalyzerName ) );
indexConfig = indexConfig.withIfAbsent( FulltextIndexSettingsKeys.EVENTUALLY_CONSISTENT, Values.booleanValue( defaultEventuallyConsistentSetting ) );
return indexConfig;
}
public void awaitRefresh()
{
indexUpdateSink.awaitUpdateApplication();
}
public Stream listAvailableAnalyzers()
{
return Services.loadAll( AnalyzerProvider.class ).stream();
}
}