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 [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
{
public static final IndexProviderDescriptor DESCRIPTOR = new IndexProviderDescriptor( "range", "1.0" );
public static final RangeIndexCapability CAPABILITY = new RangeIndexCapability();
private final boolean archiveFailedIndex;
private final Config config;
public RangeIndexProvider( DatabaseIndexContext databaseIndexContext, IndexDirectoryStructure.Factory directoryStructureFactory,
RecoveryCleanupWorkCollector recoveryCleanupWorkCollector, Config config )
{
super( databaseIndexContext, DESCRIPTOR, directoryStructureFactory, recoveryCleanupWorkCollector );
this.archiveFailedIndex = config.get( GraphDatabaseInternalSettings.archive_failed_index );
this.config = config;
}
@Override
public IndexDescriptor completeConfiguration( IndexDescriptor index )
{
return index.getCapability().equals( NO_CAPABILITY ) ? index.withIndexCapability( CAPABILITY ) : index;
}
@Override
RangeLayout layout( IndexDescriptor descriptor, Path storeFile )
{
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 )
{
return new RangeBlockBasedIndexPopulator( databaseIndexContext, indexFiles, layout, descriptor, archiveFailedIndex,
bufferFactory, config, memoryTracker, tokenNameLookup );
}
@Override
protected IndexAccessor newIndexAccessor( IndexFiles indexFiles, RangeLayout layout, IndexDescriptor descriptor, TokenNameLookup tokenNameLookup )
{
return new RangeIndexAccessor( databaseIndexContext, indexFiles, layout, recoveryCleanupWorkCollector, descriptor, tokenNameLookup );
}
@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 IndexOrderCapability orderCapability( ValueCategory... valueCategories )
{
return IndexOrderCapability.BOTH_FULLY_SORTED;
}
@Override
public IndexValueCapability valueCapability( ValueCategory... valueCategories )
{
return IndexValueCapability.YES;
}
@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;
}
switch ( queryType )
{
case ALL_ENTRIES:
case EXISTS:
case EXACT:
case STRING_PREFIX:
return true;
case RANGE:
return valueCategory != ValueCategory.UNKNOWN && valueCategory != ValueCategory.GEOMETRY;
default:
return false;
}
}
@Override
public double getCostMultiplier( IndexQueryType... queryTypes )
{
return 1.0;
}
@Override
public boolean supportPartitionedScan( IndexQuery... queries )
{
Preconditions.requireNonEmpty( queries );
Preconditions.requireNoNullElements( queries );
if ( Arrays.stream( queries ).anyMatch( query ->
EnumSet.of( IndexQueryType.TOKEN_LOOKUP, IndexQueryType.STRING_SUFFIX, IndexQueryType.STRING_CONTAINS ).contains( query.type() )
|| (query.type() == IndexQueryType.RANGE
&& EnumSet.of( ValueGroup.GEOMETRY, ValueGroup.GEOMETRY_ARRAY ).contains( ((PropertyIndexQuery) query).valueGroup() )) )
|| (queries.length > 1 && Arrays.stream( queries ).map( IndexQuery::type ).anyMatch( IndexQueryType.ALL_ENTRIES::equals )) )
{
return false;
}
for ( int i = 1; i < queries.length; i++ )
{
final var prev = queries[i - 1].type();
final var curr = queries[i].type();
if ( prev == IndexQueryType.EXACT )
{
continue;
}
if ( (EnumSet.of( IndexQueryType.EXISTS, IndexQueryType.RANGE, IndexQueryType.STRING_PREFIX ).contains( prev ))
&& !(curr == IndexQueryType.EXISTS) )
{
return false;
}
}
return true;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy