org.neo4j.kernel.impl.index.schema.NativeIndexProvider 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
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.
/*
* 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 type of {@link NativeIndexKey}
* @param type of {@link IndexLayout}
*/
abstract class NativeIndexProvider, LAYOUT extends IndexLayout>
extends IndexProvider {
protected final DatabaseIndexContext databaseIndexContext;
protected final RecoveryCleanupWorkCollector recoveryCleanupWorkCollector;
private final Monitor monitor;
protected final Config config;
protected final boolean archiveFailedIndex;
protected NativeIndexProvider(
DatabaseIndexContext databaseIndexContext,
IndexProviderDescriptor descriptor,
Factory directoryStructureFactory,
RecoveryCleanupWorkCollector recoveryCleanupWorkCollector,
Config config) {
super(KernelVersion.VERSION_RANGE_POINT_TEXT_INDEXES_ARE_INTRODUCED, descriptor, directoryStructureFactory);
this.databaseIndexContext = databaseIndexContext;
this.recoveryCleanupWorkCollector = recoveryCleanupWorkCollector;
this.monitor =
databaseIndexContext.monitors.newMonitor(IndexProvider.Monitor.class, databaseIndexContext.monitorTag);
this.config = config;
this.archiveFailedIndex = config.get(GraphDatabaseInternalSettings.archive_failed_index);
}
/**
* Instantiates the {@link Layout} which is used in the index backing this native index provider.
*
* @param descriptor the {@link IndexDescriptor} for this index.
* @return the correct {@link Layout} for the index.
*/
abstract LAYOUT layout(IndexDescriptor descriptor);
@Override
public MinimalIndexAccessor getMinimalIndexAccessor(IndexDescriptor descriptor, boolean forRebuildDuringRecovery) {
return new NativeMinimalIndexAccessor(
descriptor,
indexFiles(descriptor),
databaseIndexContext.readOnlyChecker,
archiveFailedIndex && forRebuildDuringRecovery);
}
@Override
public IndexPopulator getPopulator(
IndexDescriptor descriptor,
IndexSamplingConfig samplingConfig,
ByteBufferFactory bufferFactory,
MemoryTracker memoryTracker,
TokenNameLookup tokenNameLookup,
ImmutableSet openOptions,
StorageEngineIndexingBehaviour indexingBehaviour) {
if (databaseIndexContext.readOnlyChecker.isReadOnly()) {
throw new UnsupportedOperationException("Can't create populator for read only index");
}
IndexFiles indexFiles = indexFiles(descriptor);
return newIndexPopulator(
indexFiles, layout(descriptor), descriptor, bufferFactory, memoryTracker, tokenNameLookup, openOptions);
}
protected abstract IndexPopulator newIndexPopulator(
IndexFiles indexFiles,
LAYOUT layout,
IndexDescriptor descriptor,
ByteBufferFactory bufferFactory,
MemoryTracker memoryTracker,
TokenNameLookup tokenNameLookup,
ImmutableSet openOptions);
@Override
public IndexAccessor getOnlineAccessor(
IndexDescriptor descriptor,
IndexSamplingConfig samplingConfig,
TokenNameLookup tokenNameLookup,
ImmutableSet openOptions,
boolean readOnly,
StorageEngineIndexingBehaviour indexingBehaviour) {
IndexFiles indexFiles = indexFiles(descriptor);
return newIndexAccessor(indexFiles, layout(descriptor), descriptor, tokenNameLookup, openOptions, readOnly);
}
protected abstract IndexAccessor newIndexAccessor(
IndexFiles indexFiles,
LAYOUT layout,
IndexDescriptor descriptor,
TokenNameLookup tokenNameLookup,
ImmutableSet openOptions,
boolean readOnly);
@Override
public String getPopulationFailure(
IndexDescriptor descriptor, CursorContext cursorContext, ImmutableSet openOptions) {
try {
String failureMessage = NativeIndexes.readFailureMessage(
databaseIndexContext.pageCache,
storeFile(descriptor),
databaseIndexContext.databaseName,
cursorContext,
openOptions);
return defaultIfEmpty(failureMessage, StringUtils.EMPTY);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
@Override
public InternalIndexState getInitialState(
IndexDescriptor descriptor, CursorContext cursorContext, ImmutableSet openOptions) {
try {
return NativeIndexes.readState(
databaseIndexContext.pageCache,
storeFile(descriptor),
databaseIndexContext.databaseName,
cursorContext,
openOptions);
} catch (MetadataMismatchException | IOException e) {
monitor.failedToOpenIndex(descriptor, "Requesting re-population.", e);
return InternalIndexState.POPULATING;
}
}
@Override
public StoreMigrationParticipant storeMigrationParticipant(
FileSystemAbstraction fs,
PageCache pageCache,
PageCacheTracer pageCacheTracer,
StorageEngineFactory storageEngineFactory,
CursorContextFactory contextFactory) {
return new SchemaIndexMigrator(
getProviderDescriptor().name() + " indexes",
fs,
pageCache,
pageCacheTracer,
directoryStructure(),
storageEngineFactory,
contextFactory);
}
private Path storeFile(IndexDescriptor descriptor) {
IndexFiles indexFiles = indexFiles(descriptor);
return indexFiles.getStoreFile();
}
private IndexFiles indexFiles(IndexDescriptor descriptor) {
return new IndexFiles(databaseIndexContext.fileSystem, directoryStructure(), descriptor.getId());
}
}