org.neo4j.kernel.impl.index.schema.RangeIndexProvider 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 {
public static final IndexProviderDescriptor DESCRIPTOR = new IndexProviderDescriptor("range", "1.0");
public static final IndexCapability CAPABILITY = new RangeIndexCapability();
public RangeIndexProvider(
DatabaseIndexContext databaseIndexContext,
IndexDirectoryStructure.Factory directoryStructureFactory,
RecoveryCleanupWorkCollector recoveryCleanupWorkCollector,
Config config) {
super(databaseIndexContext, DESCRIPTOR, directoryStructureFactory, recoveryCleanupWorkCollector, config);
}
@Override
public IndexDescriptor completeConfiguration(
IndexDescriptor index, StorageEngineIndexingBehaviour indexingBehaviour) {
return index.getCapability().equals(NO_CAPABILITY) ? index.withIndexCapability(CAPABILITY) : index;
}
@Override
RangeLayout layout(IndexDescriptor descriptor) {
int numberOfSlots = descriptor.schema().getPropertyIds().length;
return new RangeLayout(numberOfSlots);
}
@Override
protected IndexPopulator newIndexPopulator(
IndexFiles indexFiles,
RangeLayout layout,
IndexDescriptor descriptor,
ByteBufferFactory bufferFactory,
MemoryTracker memoryTracker,
TokenNameLookup tokenNameLookup,
ImmutableSet openOptions) {
return new RangeBlockBasedIndexPopulator(
databaseIndexContext,
indexFiles,
layout,
descriptor,
archiveFailedIndex,
bufferFactory,
config,
memoryTracker,
tokenNameLookup,
databaseIndexContext.monitors.newMonitor(BlockBasedIndexPopulator.Monitor.class),
openOptions);
}
@Override
protected IndexAccessor newIndexAccessor(
IndexFiles indexFiles,
RangeLayout layout,
IndexDescriptor descriptor,
TokenNameLookup tokenNameLookup,
ImmutableSet openOptions,
boolean readOnly) {
return new RangeIndexAccessor(
databaseIndexContext,
indexFiles,
layout,
recoveryCleanupWorkCollector,
descriptor,
tokenNameLookup,
openOptions,
readOnly);
}
@Override
public void validatePrototype(IndexPrototype prototype) {
IndexType indexType = prototype.getIndexType();
if (indexType != IndexType.RANGE) {
String providerName = getProviderDescriptor().name();
throw new IllegalArgumentException("The '" + providerName + "' index provider does not support " + indexType
+ " indexes: " + prototype);
}
if (!(prototype.schema().isLabelSchemaDescriptor()
|| prototype.schema().isRelationshipTypeSchemaDescriptor())) {
throw new IllegalArgumentException("The " + prototype.schema()
+ " index schema is not a range index schema, which it is required to be for the '"
+ getProviderDescriptor().name() + "' index provider to be able to create an index.");
}
}
@Override
public IndexType getIndexType() {
return IndexType.RANGE;
}
private static class RangeIndexCapability implements IndexCapability {
@Override
public boolean supportsOrdering() {
return true;
}
@Override
public boolean supportsReturningValues() {
return true;
}
@Override
public boolean areValueCategoriesAccepted(ValueCategory... valueCategories) {
Preconditions.requireNonEmpty(valueCategories);
Preconditions.requireNoNullElements(valueCategories);
return true;
}
@Override
public boolean areValuesAccepted(Value... values) {
Preconditions.requireNonEmpty(values);
Preconditions.requireNoNullElements(values);
return true;
}
@Override
public boolean isQuerySupported(IndexQueryType queryType, ValueCategory valueCategory) {
if (!areValueCategoriesAccepted(valueCategory)) {
return false;
}
return switch (queryType) {
case ALL_ENTRIES, EXISTS, EXACT, RANGE, STRING_PREFIX -> true;
default -> false;
};
}
@Override
public double getCostMultiplier(IndexQueryType... queryTypes) {
return COST_MULTIPLIER_STANDARD;
}
@Override
public boolean supportPartitionedScan(IndexQuery... queries) {
Preconditions.requireNonEmpty(queries);
Preconditions.requireNoNullElements(queries);
for (int i = 0; i < queries.length; i++) {
final var query = queries[i];
final var type = query.type();
switch (type) {
case ALL_ENTRIES, EXISTS, EXACT, STRING_PREFIX:
break;
case RANGE:
switch (((PropertyIndexQuery) query).valueGroup()) {
case GEOMETRY, GEOMETRY_ARRAY:
return false;
default:
break;
}
break;
default:
return false;
}
if (i > 0) {
final var prevType = queries[i - 1].type();
switch (type) {
case EXISTS:
switch (prevType) {
case EXISTS, EXACT, RANGE, STRING_PREFIX:
break;
default:
return false;
}
break;
case EXACT, RANGE, STRING_PREFIX:
if (prevType != IndexQueryType.EXACT) {
return false;
}
break;
default:
return false;
}
}
}
return true;
}
}
}