com.palantir.atlasdb.table.description.IndexMetadata Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of atlasdb-client Show documentation
Show all versions of atlasdb-client Show documentation
Palantir open source project
/*
* (c) Copyright 2018 Palantir Technologies Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.palantir.atlasdb.table.description;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
import com.palantir.atlasdb.protos.generated.TableMetadataPersistence;
import com.palantir.atlasdb.protos.generated.TableMetadataPersistence.CachePriority;
import com.palantir.atlasdb.protos.generated.TableMetadataPersistence.SweepStrategy;
import com.palantir.atlasdb.table.description.IndexDefinition.IndexType;
import com.palantir.atlasdb.transaction.api.ConflictHandler;
import com.palantir.logsafe.Preconditions;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.Nullable;
public final class IndexMetadata {
final String name;
final String javaName;
final ImmutableList rowComponents;
final ImmutableList colComponents;
@Nullable
final String columnNameToGetData;
final CachePriority cachePriority;
boolean rangeScanAllowed;
int explicitCompressionBlockSizeKB;
boolean negativeLookups;
final ConflictHandler conflictHandler;
final IndexCondition indexCondition;
IndexType indexType;
final SweepStrategy sweepStrategy;
private boolean appendHeavyAndReadLight;
private final int numberOfComponentsHashed;
final TableMetadataPersistence.LogSafety nameLogSafety;
@SuppressWarnings("TooManyArguments") // Legacy
public static IndexMetadata createIndex(
String name,
String javaName,
Iterable rowComponents,
CachePriority cachePriority,
ConflictHandler conflictHandler,
boolean rangeScanAllowed,
int explicitCompressionBlockSizeKB,
boolean negativeLookups,
IndexCondition indexCondition,
IndexType indexType,
SweepStrategy sweepStrategy,
boolean appendHeavyAndReadLight,
int numberOfComponentsHashed,
TableMetadataPersistence.LogSafety logSafety) {
Preconditions.checkArgument(!Iterables.isEmpty(rowComponents));
Iterable colComponents = ImmutableList.of();
return new IndexMetadata(
name,
javaName,
rowComponents,
colComponents,
getColNameToAccessFrom(rowComponents, colComponents, indexCondition),
cachePriority,
conflictHandler,
rangeScanAllowed,
explicitCompressionBlockSizeKB,
negativeLookups,
indexCondition,
indexType,
sweepStrategy,
appendHeavyAndReadLight,
numberOfComponentsHashed,
logSafety);
}
@SuppressWarnings("TooManyArguments") // Legacy
public static IndexMetadata createDynamicIndex(
String name,
String javaName,
Iterable rowComponents,
Iterable colComponents,
CachePriority cachePriority,
ConflictHandler conflictHandler,
boolean rangeScanAllowed,
int explicitCompressionBlockSizeKB,
boolean negativeLookups,
IndexCondition indexCondition,
IndexType indexType,
SweepStrategy sweepStrategy,
boolean appendHeavyAndReadLight,
int numberOfComponentsHashed,
TableMetadataPersistence.LogSafety logSafety) {
Preconditions.checkArgument(!Iterables.isEmpty(rowComponents));
Preconditions.checkArgument(!Iterables.isEmpty(colComponents));
return new IndexMetadata(
name,
javaName,
rowComponents,
colComponents,
getColNameToAccessFrom(rowComponents, colComponents, indexCondition),
cachePriority,
conflictHandler,
rangeScanAllowed,
explicitCompressionBlockSizeKB,
negativeLookups,
indexCondition,
indexType,
sweepStrategy,
appendHeavyAndReadLight,
numberOfComponentsHashed,
logSafety);
}
private IndexMetadata(
String name,
String javaName,
Iterable rowComponents,
Iterable colComponents,
String colNameToAccessFrom,
CachePriority cachePriority,
ConflictHandler conflictHandler,
boolean rangeScanAllowed,
int explicitCompressionBlockSizeKB,
boolean negativeLookups,
IndexCondition indexCondition,
IndexType indexType,
SweepStrategy sweepStrategy,
boolean appendHeavyAndReadLight,
int numberOfComponentsHashed,
TableMetadataPersistence.LogSafety logSafety) {
this.name = name;
this.javaName = javaName;
this.rowComponents = ImmutableList.copyOf(rowComponents);
this.colComponents = ImmutableList.copyOf(colComponents);
this.columnNameToGetData = colNameToAccessFrom;
this.cachePriority = cachePriority;
this.conflictHandler = conflictHandler;
this.rangeScanAllowed = rangeScanAllowed;
this.explicitCompressionBlockSizeKB = explicitCompressionBlockSizeKB;
this.negativeLookups = negativeLookups;
this.indexCondition = indexCondition;
this.indexType = indexType;
this.sweepStrategy = sweepStrategy;
this.appendHeavyAndReadLight = appendHeavyAndReadLight;
this.numberOfComponentsHashed = numberOfComponentsHashed;
this.nameLogSafety = logSafety;
}
private static String getColNameToAccessFrom(
Iterable rowComponents,
Iterable colComponents,
IndexCondition indexCondition) {
String colNameToAccessFrom = null;
for (IndexComponent indexComponent : Iterables.concat(rowComponents, colComponents)) {
if (indexComponent.columnNameToGetData == null) {
continue;
}
if (colNameToAccessFrom == null) {
colNameToAccessFrom = indexComponent.columnNameToGetData;
}
if (!indexComponent.columnNameToGetData.equals(colNameToAccessFrom)) {
throw new IllegalArgumentException("An index must only reference one column."
+ "This references " + indexComponent.columnNameToGetData + " and "
+ colNameToAccessFrom);
}
}
if (indexCondition != null) {
if (colNameToAccessFrom == null) {
colNameToAccessFrom = indexCondition.getSourceColumn();
}
if (!indexCondition.getSourceColumn().equals(colNameToAccessFrom)) {
throw new IllegalArgumentException("An index must only reference one column."
+ "This references " + indexCondition.getSourceColumn() + " and "
+ colNameToAccessFrom);
}
}
return colNameToAccessFrom;
}
public TableMetadata getTableMetadata() {
List rowDescList = new ArrayList<>();
for (IndexComponent indexComp : rowComponents) {
rowDescList.add(indexComp.rowKeyDesc);
}
ColumnMetadataDescription column;
if (indexType.equals(IndexType.ADDITIVE)) {
if (colComponents.isEmpty()) {
column = getAdditiveIndexColumn();
} else {
List colDescList = new ArrayList<>();
for (IndexComponent indexComp : colComponents) {
colDescList.add(indexComp.rowKeyDesc);
}
column = getDynamicAdditiveIndexColumn(colDescList);
}
} else if (indexType.equals(IndexType.CELL_REFERENCING)) {
List colDescList = new ArrayList<>();
for (IndexComponent indexComp : colComponents) {
colDescList.add(indexComp.rowKeyDesc);
}
column = getCellReferencingIndexColumn(colDescList);
} else {
throw new IllegalArgumentException("Unknown index type " + indexType);
}
return TableMetadata.builder()
.rowMetadata(NameMetadataDescription.create(rowDescList, numberOfComponentsHashed))
.columns(column)
.conflictHandler(conflictHandler)
.cachePriority(cachePriority)
.rangeScanAllowed(rangeScanAllowed)
.explicitCompressionBlockSizeKB(explicitCompressionBlockSizeKB)
.negativeLookups(negativeLookups)
.sweepStrategy(sweepStrategy)
.appendHeavyAndReadLight(appendHeavyAndReadLight)
.nameLogSafety(nameLogSafety)
.build();
}
public boolean isDynamicIndex() {
return !colComponents.isEmpty();
}
public List getRowComponents() {
return rowComponents;
}
/**
* Calling this is only meaningful if {@link #isDynamicIndex()} returns true.
*/
public List getColumnComponents() {
return colComponents;
}
@Nullable
public String getColumnNameToAccessData() {
return columnNameToGetData;
}
public String getIndexName() {
return name;
}
public String getJavaIndexName() {
return javaName;
}
public IndexCondition getIndexCondition() {
return indexCondition;
}
public IndexType getIndexType() {
return indexType;
}
private static ColumnMetadataDescription getAdditiveIndexColumn() {
ColumnValueDescription columnValue = ColumnValueDescription.forType(ValueType.VAR_LONG);
NamedColumnDescription namedColumn = new NamedColumnDescription("e", "exists", columnValue);
return new ColumnMetadataDescription(ImmutableList.of(namedColumn));
}
private static ColumnMetadataDescription getDynamicAdditiveIndexColumn(List components) {
NameMetadataDescription columnDescription = NameMetadataDescription.create(components);
ColumnValueDescription columnValue = ColumnValueDescription.forType(ValueType.VAR_LONG);
DynamicColumnDescription dynamicColumn = new DynamicColumnDescription(columnDescription, columnValue);
return new ColumnMetadataDescription(dynamicColumn);
}
private static ColumnMetadataDescription getCellReferencingIndexColumn(List components) {
components = ImmutableList.builder()
.add(NameComponentDescription.of("row_name", ValueType.SIZED_BLOB))
.add(NameComponentDescription.of("column_name", ValueType.SIZED_BLOB))
.addAll(components)
.build();
NameMetadataDescription columnDescription = NameMetadataDescription.create(components);
ColumnValueDescription columnValue = ColumnValueDescription.forType(ValueType.VAR_LONG);
DynamicColumnDescription dynamicColumn = new DynamicColumnDescription(columnDescription, columnValue);
return new ColumnMetadataDescription(dynamicColumn);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy