All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.cassandra.index.SecondaryIndexManager Maven / Gradle / Ivy

Go to download

The Apache Cassandra Project develops a highly scalable second-generation distributed database, bringing together Dynamo's fully distributed design and Bigtable's ColumnFamily-based data model.

There is a newer version: 5.0-rc1
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.cassandra.index;

import java.lang.reflect.Constructor;
import java.util.*;
import java.util.concurrent.*;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Joiner;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import com.google.common.primitives.Longs;
import com.google.common.util.concurrent.FutureCallback;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.ListeningExecutorService;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.common.util.concurrent.SettableFuture;

import org.apache.commons.lang3.StringUtils;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.apache.cassandra.concurrent.JMXEnabledThreadPoolExecutor;
import org.apache.cassandra.concurrent.NamedThreadFactory;
import org.apache.cassandra.concurrent.Stage;
import org.apache.cassandra.config.DatabaseDescriptor;
import org.apache.cassandra.cql3.statements.schema.IndexTarget;
import org.apache.cassandra.db.*;
import org.apache.cassandra.db.compaction.CompactionManager;
import org.apache.cassandra.db.filter.RowFilter;
import org.apache.cassandra.db.lifecycle.SSTableSet;
import org.apache.cassandra.db.lifecycle.View;
import org.apache.cassandra.db.marshal.ValueAccessor;
import org.apache.cassandra.db.partitions.*;
import org.apache.cassandra.db.rows.*;
import org.apache.cassandra.exceptions.InvalidRequestException;
import org.apache.cassandra.index.Index.IndexBuildingSupport;
import org.apache.cassandra.index.internal.CassandraIndex;
import org.apache.cassandra.index.transactions.*;
import org.apache.cassandra.io.sstable.format.SSTableReader;
import org.apache.cassandra.notifications.INotification;
import org.apache.cassandra.notifications.INotificationConsumer;
import org.apache.cassandra.notifications.SSTableAddedNotification;
import org.apache.cassandra.schema.ColumnMetadata;
import org.apache.cassandra.schema.IndexMetadata;
import org.apache.cassandra.schema.Indexes;
import org.apache.cassandra.service.pager.SinglePartitionPager;
import org.apache.cassandra.tracing.Tracing;
import org.apache.cassandra.transport.ProtocolVersion;
import org.apache.cassandra.utils.FBUtilities;
import org.apache.cassandra.utils.JVMStabilityInspector;
import org.apache.cassandra.utils.concurrent.Refs;

import static org.apache.cassandra.utils.ExecutorUtils.awaitTermination;
import static org.apache.cassandra.utils.ExecutorUtils.shutdown;

/**
 * Handles the core maintenance functionality associated with indexes: adding/removing them to or from
 * a table, (re)building during bootstrap or other streaming operations, flushing, reloading metadata
 * and so on.
 * 

* The Index interface defines a number of methods which return {@code Callable}. These are primarily the * management tasks for an index implementation. Most of them are currently executed in a blocking * fashion via submission to SIM's blockingExecutor. This provides the desired behaviour in pretty * much all cases, as tasks like flushing an index needs to be executed synchronously to avoid potentially * deadlocking on the FlushWriter or PostFlusher. Several of these {@code Callable} returning methods on Index could * then be defined with as void and called directly from SIM (rather than being run via the executor service). * Separating the task defintion from execution gives us greater flexibility though, so that in future, for example, * if the flush process allows it we leave open the possibility of executing more of these tasks asynchronously. *

* The primary exception to the above is the Callable returned from Index#addIndexedColumn. This may * involve a significant effort, building a new index over any existing data. We perform this task asynchronously; * as it is called as part of a schema update, which we do not want to block for a long period. Building non-custom * indexes is performed on the CompactionManager. *

* This class also provides instances of processors which listen to updates to the base table and forward to * registered Indexes the info required to keep those indexes up to date. * There are two variants of these processors, each with a factory method provided by SIM: * IndexTransaction: deals with updates generated on the regular write path. * CleanupTransaction: used when partitions are modified during compaction or cleanup operations. * Further details on their usage and lifecycles can be found in the interface definitions below. *

* The bestIndexFor method is used at query time to identify the most selective index of those able * to satisfy any search predicates defined by a ReadCommand's RowFilter. It returns a thin IndexAccessor object * which enables the ReadCommand to access the appropriate functions of the Index at various stages in its lifecycle. * e.g. the getEstimatedResultRows is required when StorageProxy calculates the initial concurrency factor for * distributing requests to replicas, whereas a Searcher instance is needed when the ReadCommand is executed locally on * a target replica. *

* Finally, this class provides a clear and safe lifecycle to manage index builds, either full rebuilds via * {@link this#rebuildIndexesBlocking(Set)} or builds of new sstables * added via {@link org.apache.cassandra.notifications.SSTableAddedNotification}s, guaranteeing * the following: *
    *
  • The initialization task and any subsequent successful (re)build mark the index as built.
  • *
  • If any (re)build operation fails, the index is not marked as built, and only another full rebuild can mark the * index as built.
  • *
  • Full rebuilds cannot be run concurrently with other full or sstable (re)builds.
  • *
  • SSTable builds can always be run concurrently with any other builds.
  • *
*/ public class SecondaryIndexManager implements IndexRegistry, INotificationConsumer { private static final Logger logger = LoggerFactory.getLogger(SecondaryIndexManager.class); // default page size (in rows) when rebuilding the index for a whole partition public static final int DEFAULT_PAGE_SIZE = 10000; /** * All registered indexes. */ private final Map indexes = Maps.newConcurrentMap(); /** * The indexes that had a build failure. */ private final Set needsFullRebuild = Sets.newConcurrentHashSet(); /** * The indexes that are available for querying. */ private final Set queryableIndexes = Sets.newConcurrentHashSet(); /** * The indexes that are available for writing. */ private final Map writableIndexes = Maps.newConcurrentMap(); /** * The count of pending index builds for each index. */ private final Map inProgressBuilds = Maps.newConcurrentMap(); // executes tasks returned by Indexer#addIndexColumn which may require index(es) to be (re)built private static final ListeningExecutorService asyncExecutor = MoreExecutors.listeningDecorator( new JMXEnabledThreadPoolExecutor(1, Stage.KEEP_ALIVE_SECONDS, TimeUnit.SECONDS, new LinkedBlockingQueue<>(), new NamedThreadFactory("SecondaryIndexManagement"), "internal")); // executes all blocking tasks produced by Indexers e.g. getFlushTask, getMetadataReloadTask etc private static final ListeningExecutorService blockingExecutor = MoreExecutors.newDirectExecutorService(); /** * The underlying column family containing the source data for these indexes */ public final ColumnFamilyStore baseCfs; private final Keyspace keyspace; public SecondaryIndexManager(ColumnFamilyStore baseCfs) { this.baseCfs = baseCfs; this.keyspace = baseCfs.keyspace; baseCfs.getTracker().subscribe(this); } /** * Drops and adds new indexes associated with the underlying CF */ public void reload() { // figure out what needs to be added and dropped. Indexes tableIndexes = baseCfs.metadata().indexes; indexes.keySet() .stream() .filter(indexName -> !tableIndexes.has(indexName)) .forEach(this::removeIndex); // we call add for every index definition in the collection as // some may not have been created here yet, only added to schema for (IndexMetadata tableIndex : tableIndexes) addIndex(tableIndex, false); } private Future reloadIndex(IndexMetadata indexDef) { Index index = indexes.get(indexDef.name); Callable reloadTask = index.getMetadataReloadTask(indexDef); return reloadTask == null ? Futures.immediateFuture(null) : blockingExecutor.submit(reloadTask); } @SuppressWarnings("unchecked") private synchronized Future createIndex(IndexMetadata indexDef, boolean isNewCF) { final Index index = createInstance(indexDef); index.register(this); if (writableIndexes.put(index.getIndexMetadata().name, index) == null) logger.info("Index [{}] registered and writable.", index.getIndexMetadata().name); markIndexesBuilding(ImmutableSet.of(index), true, isNewCF); Callable initialBuildTask = null; // if the index didn't register itself, we can probably assume that no initialization needs to happen if (indexes.containsKey(indexDef.name)) { try { initialBuildTask = index.getInitializationTask(); } catch (Throwable t) { logAndMarkIndexesFailed(Collections.singleton(index), t, true); throw t; } } // if there's no initialization, just mark as built and return: if (initialBuildTask == null) { markIndexBuilt(index, true); return Futures.immediateFuture(null); } // otherwise run the initialization task asynchronously with a callback to mark it built or failed final SettableFuture initialization = SettableFuture.create(); Futures.addCallback(asyncExecutor.submit(initialBuildTask), new FutureCallback() { @Override public void onFailure(Throwable t) { logAndMarkIndexesFailed(Collections.singleton(index), t, true); initialization.setException(t); } @Override public void onSuccess(Object o) { markIndexBuilt(index, true); initialization.set(o); } }, MoreExecutors.directExecutor()); return initialization; } /** * Adds and builds a index * * @param indexDef the IndexMetadata describing the index * @param isNewCF true if the index is added as part of a new table/columnfamily (i.e. loading a CF at startup), * false for all other cases (i.e. newly added index) */ public synchronized Future addIndex(IndexMetadata indexDef, boolean isNewCF) { if (indexes.containsKey(indexDef.name)) return reloadIndex(indexDef); else return createIndex(indexDef, isNewCF); } /** * Checks if the specified index is queryable. * * @param index the index * @return true if the specified index is queryable, false otherwise */ public boolean isIndexQueryable(Index index) { return queryableIndexes.contains(index.getIndexMetadata().name); } /** * Checks if the specified index is writable. * * @param index the index * @return true if the specified index is writable, false otherwise */ public boolean isIndexWritable(Index index) { return writableIndexes.containsKey(index.getIndexMetadata().name); } /** * Checks if the specified index has any running build task. * * @param indexName the index name * @return {@code true} if the index is building, {@code false} otherwise */ @VisibleForTesting public synchronized boolean isIndexBuilding(String indexName) { AtomicInteger counter = inProgressBuilds.get(indexName); return counter != null && counter.get() > 0; } public synchronized void removeIndex(String indexName) { Index index = unregisterIndex(indexName); if (null != index) { markIndexRemoved(indexName); executeBlocking(index.getInvalidateTask(), null); } } public Set getDependentIndexes(ColumnMetadata column) { if (indexes.isEmpty()) return Collections.emptySet(); Set dependentIndexes = new HashSet<>(); for (Index index : indexes.values()) if (index.dependsOn(column)) dependentIndexes.add(index.getIndexMetadata()); return dependentIndexes; } /** * Called when dropping a Table */ public void markAllIndexesRemoved() { getBuiltIndexNames().forEach(this::markIndexRemoved); } /** * Does a blocking full rebuild/recovery of the specifed indexes from all the sstables in the base table. * Note also that this method of (re)building/recovering indexes: * a) takes a set of index *names* rather than Indexers * b) marks existing indexes removed prior to rebuilding * c) fails if such marking operation conflicts with any ongoing index builds, as full rebuilds cannot be run * concurrently * * @param indexNames the list of indexes to be rebuilt */ public void rebuildIndexesBlocking(Set indexNames) { // Get the set of indexes that require blocking build Set toRebuild = indexes.values() .stream() .filter(index -> indexNames.contains(index.getIndexMetadata().name)) .filter(Index::shouldBuildBlocking) .collect(Collectors.toSet()); if (toRebuild.isEmpty()) { logger.info("No defined indexes with the supplied names: {}", Joiner.on(',').join(indexNames)); return; } // Optimistically mark the indexes as writable, so we don't miss incoming writes boolean needsFlush = false; for (Index index : toRebuild) { String name = index.getIndexMetadata().name; if (writableIndexes.put(name, index) == null) { logger.info("Index [{}] became writable starting recovery.", name); needsFlush = true; } } // Once we are tracking new writes, flush any memtable contents to not miss them from the sstable-based rebuild if (needsFlush) baseCfs.forceBlockingFlush(); // Now that we are tracking new writes and we haven't left untracked contents on the memtables, we are ready to // index the sstables try (ColumnFamilyStore.RefViewFragment viewFragment = baseCfs.selectAndReference(View.selectFunction(SSTableSet.CANONICAL)); Refs allSSTables = viewFragment.refs) { buildIndexesBlocking(allSSTables, toRebuild, true); } } /** * Checks if the specified {@link ColumnFamilyStore} is a secondary index. * * @param cfs the ColumnFamilyStore to check. * @return true if the specified ColumnFamilyStore is a secondary index, * false otherwise. */ public static boolean isIndexColumnFamilyStore(ColumnFamilyStore cfs) { return isIndexColumnFamily(cfs.name); } /** * Checks if the specified {@link ColumnFamilyStore} is the one secondary index. * * @param cfName the name of the ColumnFamilyStore to check. * @return true if the specified ColumnFamilyStore is a secondary index, * false otherwise. */ public static boolean isIndexColumnFamily(String cfName) { return cfName.contains(Directories.SECONDARY_INDEX_NAME_SEPARATOR); } /** * Returns the parent of the specified {@link ColumnFamilyStore}. * * @param cfs the ColumnFamilyStore * @return the parent of the specified ColumnFamilyStore */ public static ColumnFamilyStore getParentCfs(ColumnFamilyStore cfs) { String parentCfs = getParentCfsName(cfs.name); return cfs.keyspace.getColumnFamilyStore(parentCfs); } /** * Returns the parent name of the specified {@link ColumnFamilyStore}. * * @param cfName the ColumnFamilyStore name * @return the parent name of the specified ColumnFamilyStore */ public static String getParentCfsName(String cfName) { assert isIndexColumnFamily(cfName); return StringUtils.substringBefore(cfName, Directories.SECONDARY_INDEX_NAME_SEPARATOR); } /** * Returns the index name * * @param cfs the ColumnFamilyStore * @return the index name */ public static String getIndexName(ColumnFamilyStore cfs) { return getIndexName(cfs.name); } /** * Returns the index name * * @param cfName the ColumnFamilyStore name * @return the index name */ public static String getIndexName(String cfName) { assert isIndexColumnFamily(cfName); return StringUtils.substringAfter(cfName, Directories.SECONDARY_INDEX_NAME_SEPARATOR); } /** * Performs a blocking (re)indexing/recovery of the specified SSTables for the specified indexes. * * If the index doesn't support ALL {@link Index.LoadType} it performs a recovery {@link Index#getRecoveryTaskSupport()} * instead of a build {@link Index#getBuildTaskSupport()} * * @param sstables the SSTables to be (re)indexed * @param indexes the indexes to be (re)built for the specifed SSTables * @param isFullRebuild True if this method is invoked as a full index rebuild, false otherwise */ @SuppressWarnings({ "unchecked" }) private void buildIndexesBlocking(Collection sstables, Set indexes, boolean isFullRebuild) { if (indexes.isEmpty()) return; // Mark all indexes as building: this step must happen first, because if any index can't be marked, the whole // process needs to abort markIndexesBuilding(indexes, isFullRebuild, false); // Build indexes in a try/catch, so that any index not marked as either built or failed will be marked as failed: final Set builtIndexes = Sets.newConcurrentHashSet(); final Set unbuiltIndexes = Sets.newConcurrentHashSet(); // Any exception thrown during index building that could be suppressed by the finally block Exception accumulatedFail = null; try { logger.info("Submitting index {} of {} for data in {}", isFullRebuild ? "recovery" : "build", indexes.stream().map(i -> i.getIndexMetadata().name).collect(Collectors.joining(",")), sstables.stream().map(SSTableReader::toString).collect(Collectors.joining(","))); // Group all building tasks Map> byType = new HashMap<>(); for (Index index : indexes) { IndexBuildingSupport buildOrRecoveryTask = isFullRebuild ? index.getBuildTaskSupport() : index.getRecoveryTaskSupport(); Set stored = byType.computeIfAbsent(buildOrRecoveryTask, i -> new HashSet<>()); stored.add(index); } // Schedule all index building tasks with a callback to mark them as built or failed List> futures = new ArrayList<>(byType.size()); byType.forEach((buildingSupport, groupedIndexes) -> { SecondaryIndexBuilder builder = buildingSupport.getIndexBuildTask(baseCfs, groupedIndexes, sstables); final SettableFuture build = SettableFuture.create(); Futures.addCallback(CompactionManager.instance.submitIndexBuild(builder), new FutureCallback() { @Override public void onFailure(Throwable t) { logAndMarkIndexesFailed(groupedIndexes, t, false); unbuiltIndexes.addAll(groupedIndexes); build.setException(t); } @Override public void onSuccess(Object o) { groupedIndexes.forEach(i -> markIndexBuilt(i, isFullRebuild)); logger.info("Index build of {} completed", getIndexNames(groupedIndexes)); builtIndexes.addAll(groupedIndexes); build.set(o); } }, MoreExecutors.directExecutor()); futures.add(build); }); // Finally wait for the index builds to finish and flush the indexes that built successfully FBUtilities.waitOnFutures(futures); } catch (Exception e) { accumulatedFail = e; throw e; } finally { try { // Fail any indexes that couldn't be marked Set failedIndexes = Sets.difference(indexes, Sets.union(builtIndexes, unbuiltIndexes)); if (!failedIndexes.isEmpty()) { logAndMarkIndexesFailed(failedIndexes, accumulatedFail, false); } // Flush all built indexes with an aynchronous callback to log the success or failure of the flush flushIndexesBlocking(builtIndexes, new FutureCallback() { String indexNames = StringUtils.join(builtIndexes.stream() .map(i -> i.getIndexMetadata().name) .collect(Collectors.toList()), ','); @Override public void onFailure(Throwable ignored) { logger.info("Index flush of {} failed", indexNames); } @Override public void onSuccess(Object ignored) { logger.info("Index flush of {} completed", indexNames); } }); } catch (Exception e) { if (accumulatedFail != null) { accumulatedFail.addSuppressed(e); } else { throw e; } } } } private String getIndexNames(Set indexes) { List indexNames = indexes.stream() .map(i -> i.getIndexMetadata().name) .collect(Collectors.toList()); return StringUtils.join(indexNames, ','); } /** * Marks the specified indexes as (re)building if: * 1) There's no in progress rebuild of any of the given indexes. * 2) There's an in progress rebuild but the caller is not a full rebuild. *

* Otherwise, this method invocation fails, as it is not possible to run full rebuilds while other concurrent rebuilds * are in progress. Please note this is checked atomically against all given indexes; that is, no index will be marked * if even a single one fails. *

* Marking an index as "building" practically means: * 1) The index is removed from the "failed" set if this is a full rebuild. * 2) The index is removed from the system keyspace built indexes; this only happens if this method is not invoked * for a new table initialization, as in such case there's no need to remove it (it is either already not present, * or already present because already built). *

* Thread safety is guaranteed by having all methods managing index builds synchronized: being synchronized on * the SecondaryIndexManager instance, it means all invocations for all different indexes will go through the same * lock, but this is fine as the work done while holding such lock is trivial. *

* {@link #markIndexBuilt(Index, boolean)} or {@link #markIndexFailed(Index, boolean)} should be always called after * the rebuilding has finished, so that the index build state can be correctly managed and the index rebuilt. * * @param indexes the index to be marked as building * @param isFullRebuild {@code true} if this method is invoked as a full index rebuild, {@code false} otherwise * @param isNewCF {@code true} if this method is invoked when initializing a new table/columnfamily (i.e. loading a CF at startup), * {@code false} for all other cases (i.e. newly added index) */ private synchronized void markIndexesBuilding(Set indexes, boolean isFullRebuild, boolean isNewCF) { String keyspaceName = baseCfs.keyspace.getName(); // First step is to validate against concurrent rebuilds; it would be more optimized to do everything on a single // step, but we're not really expecting a very high number of indexes, and this isn't on any hot path, so // we're favouring readability over performance indexes.forEach(index -> { String indexName = index.getIndexMetadata().name; AtomicInteger counter = inProgressBuilds.computeIfAbsent(indexName, ignored -> new AtomicInteger(0)); if (counter.get() > 0 && isFullRebuild) throw new IllegalStateException(String.format("Cannot rebuild index %s as another index build for the same index is currently in progress.", indexName)); }); // Second step is the actual marking: indexes.forEach(index -> { String indexName = index.getIndexMetadata().name; AtomicInteger counter = inProgressBuilds.computeIfAbsent(indexName, ignored -> new AtomicInteger(0)); if (isFullRebuild) needsFullRebuild.remove(indexName); if (counter.getAndIncrement() == 0 && DatabaseDescriptor.isDaemonInitialized() && !isNewCF) SystemKeyspace.setIndexRemoved(keyspaceName, indexName); }); } /** * Marks the specified index as built if there are no in progress index builds and the index is not failed. * {@link #markIndexesBuilding(Set, boolean, boolean)} should always be invoked before this method. * * @param index the index to be marked as built * @param isFullRebuild {@code true} if this method is invoked as a full index rebuild, {@code false} otherwise */ private synchronized void markIndexBuilt(Index index, boolean isFullRebuild) { String indexName = index.getIndexMetadata().name; if (isFullRebuild) { if (queryableIndexes.add(indexName)) logger.info("Index [{}] became queryable after successful build.", indexName); if (writableIndexes.put(indexName, index) == null) logger.info("Index [{}] became writable after successful build.", indexName); } AtomicInteger counter = inProgressBuilds.get(indexName); if (counter != null) { assert counter.get() > 0; if (counter.decrementAndGet() == 0) { inProgressBuilds.remove(indexName); if (!needsFullRebuild.contains(indexName) && DatabaseDescriptor.isDaemonInitialized()) SystemKeyspace.setIndexBuilt(baseCfs.keyspace.getName(), indexName); } } } /** * Marks the specified index as failed. * {@link #markIndexesBuilding(Set, boolean, boolean)} should always be invoked before this method. * * @param index the index to be marked as built * @param isInitialBuild {@code true} if the index failed during its initial build, {@code false} otherwise */ private synchronized void markIndexFailed(Index index, boolean isInitialBuild) { String indexName = index.getIndexMetadata().name; AtomicInteger counter = inProgressBuilds.get(indexName); if (counter != null) { assert counter.get() > 0; counter.decrementAndGet(); if (DatabaseDescriptor.isDaemonInitialized()) SystemKeyspace.setIndexRemoved(baseCfs.keyspace.getName(), indexName); needsFullRebuild.add(indexName); if (!index.getSupportedLoadTypeOnFailure(isInitialBuild).supportsWrites() && writableIndexes.remove(indexName) != null) logger.info("Index [{}] became not-writable because of failed build.", indexName); if (!index.getSupportedLoadTypeOnFailure(isInitialBuild).supportsReads() && queryableIndexes.remove(indexName)) logger.info("Index [{}] became not-queryable because of failed build.", indexName); } } private void logAndMarkIndexesFailed(Set indexes, Throwable indexBuildFailure, boolean isInitialBuild) { JVMStabilityInspector.inspectThrowable(indexBuildFailure); if (indexBuildFailure != null) logger.warn("Index build of {} failed. Please run full index rebuild to fix it.", getIndexNames(indexes), indexBuildFailure); else logger.warn("Index build of {} failed. Please run full index rebuild to fix it.", getIndexNames(indexes)); indexes.forEach(i -> this.markIndexFailed(i, isInitialBuild)); } /** * Marks the specified index as removed. * * @param indexName the index name */ private synchronized void markIndexRemoved(String indexName) { SystemKeyspace.setIndexRemoved(baseCfs.keyspace.getName(), indexName); queryableIndexes.remove(indexName); writableIndexes.remove(indexName); needsFullRebuild.remove(indexName); inProgressBuilds.remove(indexName); } public Index getIndexByName(String indexName) { return indexes.get(indexName); } private Index createInstance(IndexMetadata indexDef) { Index newIndex; if (indexDef.isCustom()) { assert indexDef.options != null; String className = indexDef.options.get(IndexTarget.CUSTOM_INDEX_OPTION_NAME); assert !Strings.isNullOrEmpty(className); try { Class indexClass = FBUtilities.classForName(className, "Index"); Constructor ctor = indexClass.getConstructor(ColumnFamilyStore.class, IndexMetadata.class); newIndex = ctor.newInstance(baseCfs, indexDef); } catch (Exception e) { throw new RuntimeException(e); } } else { newIndex = CassandraIndex.newIndex(baseCfs, indexDef); } return newIndex; } /** * Truncate all indexes */ public void truncateAllIndexesBlocking(final long truncatedAt) { executeAllBlocking(indexes.values().stream(), (index) -> index.getTruncateTask(truncatedAt), null); } /** * Remove all indexes */ public void dropAllIndexes() { markAllIndexesRemoved(); invalidateAllIndexesBlocking(); } @VisibleForTesting public void invalidateAllIndexesBlocking() { executeAllBlocking(indexes.values().stream(), Index::getInvalidateTask, null); } /** * Perform a blocking flush all indexes */ public void flushAllIndexesBlocking() { flushIndexesBlocking(ImmutableSet.copyOf(indexes.values())); } /** * Perform a blocking flush of selected indexes */ public void flushIndexesBlocking(Set indexes) { flushIndexesBlocking(indexes, null); } /** * Performs a blocking flush of all custom indexes */ public void flushAllNonCFSBackedIndexesBlocking() { executeAllBlocking(indexes.values() .stream() .filter(index -> !index.getBackingTable().isPresent()), Index::getBlockingFlushTask, null); } /** * Performs a blocking execution of pre-join tasks of all indexes */ public void executePreJoinTasksBlocking(boolean hadBootstrap) { logger.info("Executing pre-join{} tasks for: {}", hadBootstrap ? " post-bootstrap" : "", this.baseCfs); executeAllBlocking(indexes.values().stream(), (index) -> { return index.getPreJoinTask(hadBootstrap); }, null); } private void flushIndexesBlocking(Set indexes, FutureCallback callback) { if (indexes.isEmpty()) return; List> wait = new ArrayList<>(); List nonCfsIndexes = new ArrayList<>(); // for each CFS backed index, submit a flush task which we'll wait on for completion // for the non-CFS backed indexes, we'll flush those while we wait. synchronized (baseCfs.getTracker()) { indexes.forEach(index -> index.getBackingTable() .map(cfs -> wait.add(cfs.forceFlush())) .orElseGet(() -> nonCfsIndexes.add(index))); } executeAllBlocking(nonCfsIndexes.stream(), Index::getBlockingFlushTask, callback); FBUtilities.waitOnFutures(wait); } /** * @return all indexes which are marked as built and ready to use */ public List getBuiltIndexNames() { Set allIndexNames = new HashSet<>(); indexes.values().stream() .map(i -> i.getIndexMetadata().name) .forEach(allIndexNames::add); return SystemKeyspace.getBuiltIndexes(baseCfs.keyspace.getName(), allIndexNames); } /** * @return all backing Tables used by registered indexes */ public Set getAllIndexColumnFamilyStores() { Set backingTables = new HashSet<>(); indexes.values().forEach(index -> index.getBackingTable().ifPresent(backingTables::add)); return backingTables; } /** * @return if there are ANY indexes registered for this table */ public boolean hasIndexes() { return !indexes.isEmpty(); } /** * When building an index against existing data in sstables, add the given partition to the index */ public void indexPartition(DecoratedKey key, Set indexes, int pageSize) { if (logger.isTraceEnabled()) logger.trace("Indexing partition {}", baseCfs.metadata().partitionKeyType.getString(key.getKey())); if (!indexes.isEmpty()) { SinglePartitionReadCommand cmd = SinglePartitionReadCommand.fullPartitionRead(baseCfs.metadata(), FBUtilities.nowInSeconds(), key); int nowInSec = cmd.nowInSec(); boolean readStatic = false; SinglePartitionPager pager = new SinglePartitionPager(cmd, null, ProtocolVersion.CURRENT); while (!pager.isExhausted()) { try (ReadExecutionController controller = cmd.executionController(); WriteContext ctx = keyspace.getWriteHandler().createContextForIndexing(); UnfilteredPartitionIterator page = pager.fetchPageUnfiltered(baseCfs.metadata(), pageSize, controller)) { if (!page.hasNext()) break; try (UnfilteredRowIterator partition = page.next()) { Set indexers = indexes.stream() .map(index -> index.indexerFor(key, partition.columns(), nowInSec, ctx, IndexTransaction.Type.UPDATE)) .filter(Objects::nonNull) .collect(Collectors.toSet()); // Short-circuit empty partitions if static row is processed or isn't read if (!readStatic && partition.isEmpty() && partition.staticRow().isEmpty()) break; indexers.forEach(Index.Indexer::begin); if (!readStatic) { if (!partition.staticRow().isEmpty()) indexers.forEach(indexer -> indexer.insertRow(partition.staticRow())); indexers.forEach((Index.Indexer i) -> i.partitionDelete(partition.partitionLevelDeletion())); readStatic = true; } MutableDeletionInfo.Builder deletionBuilder = MutableDeletionInfo.builder(partition.partitionLevelDeletion(), baseCfs.getComparator(), false); while (partition.hasNext()) { Unfiltered unfilteredRow = partition.next(); if (unfilteredRow.isRow()) { Row row = (Row) unfilteredRow; indexers.forEach(indexer -> indexer.insertRow(row)); } else { assert unfilteredRow.isRangeTombstoneMarker(); RangeTombstoneMarker marker = (RangeTombstoneMarker) unfilteredRow; deletionBuilder.add(marker); } } MutableDeletionInfo deletionInfo = deletionBuilder.build(); if (deletionInfo.hasRanges()) { Iterator iter = deletionInfo.rangeIterator(false); while (iter.hasNext()) { RangeTombstone rt = iter.next(); indexers.forEach(indexer -> indexer.rangeTombstone(rt)); } } indexers.forEach(Index.Indexer::finish); } } } } } /** * Return the page size used when indexing an entire partition */ public int calculateIndexingPageSize() { if (Boolean.getBoolean("cassandra.force_default_indexing_page_size")) return DEFAULT_PAGE_SIZE; double targetPageSizeInBytes = 32 * 1024 * 1024; double meanPartitionSize = baseCfs.getMeanPartitionSize(); if (meanPartitionSize <= 0) return DEFAULT_PAGE_SIZE; int meanCellsPerPartition = baseCfs.getMeanEstimatedCellPerPartitionCount(); if (meanCellsPerPartition <= 0) return DEFAULT_PAGE_SIZE; int columnsPerRow = baseCfs.metadata().regularColumns().size(); if (columnsPerRow <= 0) return DEFAULT_PAGE_SIZE; int meanRowsPerPartition = meanCellsPerPartition / columnsPerRow; double meanRowSize = meanPartitionSize / meanRowsPerPartition; int pageSize = (int) Math.max(1, Math.min(DEFAULT_PAGE_SIZE, targetPageSizeInBytes / meanRowSize)); logger.trace("Calculated page size {} for indexing {}.{} ({}/{}/{}/{})", pageSize, baseCfs.metadata.keyspace, baseCfs.metadata.name, meanPartitionSize, meanCellsPerPartition, meanRowsPerPartition, meanRowSize); return pageSize; } /** * Delete all data from all indexes for this partition. * For when cleanup rips a partition out entirely. *

* TODO : improve cleanup transaction to batch updates and perform them async */ public void deletePartition(UnfilteredRowIterator partition, int nowInSec) { // we need to acquire memtable lock because secondary index deletion may // cause a race (see CASSANDRA-3712). This is done internally by the // index transaction when it commits CleanupTransaction indexTransaction = newCleanupTransaction(partition.partitionKey(), partition.columns(), nowInSec); indexTransaction.start(); indexTransaction.onPartitionDeletion(new DeletionTime(FBUtilities.timestampMicros(), nowInSec)); indexTransaction.commit(); while (partition.hasNext()) { Unfiltered unfiltered = partition.next(); if (unfiltered.kind() != Unfiltered.Kind.ROW) continue; indexTransaction = newCleanupTransaction(partition.partitionKey(), partition.columns(), nowInSec); indexTransaction.start(); indexTransaction.onRowDelete((Row) unfiltered); indexTransaction.commit(); } } /** * Called at query time to choose which (if any) of the registered index implementations to use for a given query. *

* This is a two step processes, firstly compiling the set of searchable indexes then choosing the one which reduces * the search space the most. *

* In the first phase, if the command's RowFilter contains any custom index expressions, the indexes that they * specify are automatically included. Following that, the registered indexes are filtered to include only those * which support the standard expressions in the RowFilter. *

* The filtered set then sorted by selectivity, as reported by the Index implementations' getEstimatedResultRows * method. *

* Implementation specific validation of the target expression, either custom or standard, by the selected * index should be performed in the searcherFor method to ensure that we pick the right index regardless of * the validity of the expression. *

* This method is only called once during the lifecycle of a ReadCommand and the result is * cached for future use when obtaining a Searcher, getting the index's underlying CFS for * ReadOrderGroup, or an estimate of the result size from an average index query. * * @param rowFilter RowFilter of the command to be executed * @return an Index instance, ready to use during execution of the command, or null if none * of the registered indexes can support the command. */ public Index getBestIndexFor(RowFilter rowFilter) { if (indexes.isEmpty() || rowFilter.isEmpty()) return null; Set searchableIndexes = new HashSet<>(); for (RowFilter.Expression expression : rowFilter) { if (expression.isCustom()) { // Only a single custom expression is allowed per query and, if present, // we want to always favour the index specified in such an expression RowFilter.CustomExpression customExpression = (RowFilter.CustomExpression) expression; logger.trace("Command contains a custom index expression, using target index {}", customExpression.getTargetIndex().name); Tracing.trace("Command contains a custom index expression, using target index {}", customExpression.getTargetIndex().name); return indexes.get(customExpression.getTargetIndex().name); } else if (!expression.isUserDefined()) { indexes.values().stream() .filter(index -> index.supportsExpression(expression.column(), expression.operator())) .forEach(searchableIndexes::add); } } if (searchableIndexes.isEmpty()) { logger.trace("No applicable indexes found"); Tracing.trace("No applicable indexes found"); return null; } Index selected = searchableIndexes.size() == 1 ? Iterables.getOnlyElement(searchableIndexes) : searchableIndexes.stream() .min((a, b) -> Longs.compare(a.getEstimatedResultRows(), b.getEstimatedResultRows())) .orElseThrow(() -> new AssertionError("Could not select most selective index")); // pay for an additional threadlocal get() rather than build the strings unnecessarily if (Tracing.isTracing()) { Tracing.trace("Index mean cardinalities are {}. Scanning with {}.", searchableIndexes.stream().map(i -> i.getIndexMetadata().name + ':' + i.getEstimatedResultRows()) .collect(Collectors.joining(",")), selected.getIndexMetadata().name); } return selected; } public Optional getBestIndexFor(RowFilter.Expression expression) { return indexes.values().stream().filter((i) -> i.supportsExpression(expression.column(), expression.operator())).findFirst(); } /** * Called at write time to ensure that values present in the update * are valid according to the rules of all registered indexes which * will process it. The partition key as well as the clustering and * cell values for each row in the update may be checked by index * implementations * * @param update PartitionUpdate containing the values to be validated by registered Index implementations * @throws InvalidRequestException */ public void validate(PartitionUpdate update) throws InvalidRequestException { for (Index index : indexes.values()) index.validate(update); } /* * IndexRegistry methods */ public void registerIndex(Index index) { String name = index.getIndexMetadata().name; indexes.put(name, index); logger.trace("Registered index {}", name); } public void unregisterIndex(Index index) { unregisterIndex(index.getIndexMetadata().name); } private Index unregisterIndex(String name) { Index removed = indexes.remove(name); logger.trace(removed == null ? "Index {} was not registered" : "Removed index {} from registry", name); return removed; } public Index getIndex(IndexMetadata metadata) { return indexes.get(metadata.name); } public Collection listIndexes() { return ImmutableSet.copyOf(indexes.values()); } /* * Handling of index updates. * Implementations of the various IndexTransaction interfaces, for keeping indexes in sync with base data * during updates, compaction and cleanup. Plus factory methods for obtaining transaction instances. */ /** * Transaction for updates on the write path. */ public UpdateTransaction newUpdateTransaction(PartitionUpdate update, WriteContext ctx, int nowInSec) { if (!hasIndexes()) return UpdateTransaction.NO_OP; ArrayList idxrs = new ArrayList<>(); for (Index i : writableIndexes.values()) { Index.Indexer idxr = i.indexerFor(update.partitionKey(), update.columns(), nowInSec, ctx, IndexTransaction.Type.UPDATE); if (idxr != null) idxrs.add(idxr); } if (idxrs.size() == 0) return UpdateTransaction.NO_OP; else return new WriteTimeTransaction(idxrs.toArray(new Index.Indexer[idxrs.size()])); } /** * Transaction for use when merging rows during compaction */ public CompactionTransaction newCompactionTransaction(DecoratedKey key, RegularAndStaticColumns regularAndStaticColumns, int versions, int nowInSec) { // the check for whether there are any registered indexes is already done in CompactionIterator return new IndexGCTransaction(key, regularAndStaticColumns, keyspace, versions, nowInSec, writableIndexes.values()); } /** * Transaction for use when removing partitions during cleanup */ public CleanupTransaction newCleanupTransaction(DecoratedKey key, RegularAndStaticColumns regularAndStaticColumns, int nowInSec) { if (!hasIndexes()) return CleanupTransaction.NO_OP; return new CleanupGCTransaction(key, regularAndStaticColumns, keyspace, nowInSec, writableIndexes.values()); } /** * A single use transaction for processing a partition update on the regular write path */ private static final class WriteTimeTransaction implements UpdateTransaction { private final Index.Indexer[] indexers; private WriteTimeTransaction(Index.Indexer... indexers) { // don't allow null indexers, if we don't need any use a NullUpdater object for (Index.Indexer indexer : indexers) assert indexer != null; this.indexers = indexers; } public void start() { for (Index.Indexer indexer : indexers) indexer.begin(); } public void onPartitionDeletion(DeletionTime deletionTime) { for (Index.Indexer indexer : indexers) indexer.partitionDelete(deletionTime); } public void onRangeTombstone(RangeTombstone tombstone) { for (Index.Indexer indexer : indexers) indexer.rangeTombstone(tombstone); } public void onInserted(Row row) { for (Index.Indexer indexer : indexers) indexer.insertRow(row); } public void onUpdated(Row existing, Row updated) { final Row.Builder toRemove = BTreeRow.sortedBuilder(); toRemove.newRow(existing.clustering()); toRemove.addPrimaryKeyLivenessInfo(existing.primaryKeyLivenessInfo()); toRemove.addRowDeletion(existing.deletion()); final Row.Builder toInsert = BTreeRow.sortedBuilder(); toInsert.newRow(updated.clustering()); toInsert.addPrimaryKeyLivenessInfo(updated.primaryKeyLivenessInfo()); toInsert.addRowDeletion(updated.deletion()); // diff listener collates the columns to be added & removed from the indexes RowDiffListener diffListener = new RowDiffListener() { public void onPrimaryKeyLivenessInfo(int i, Clustering clustering, LivenessInfo merged, LivenessInfo original) { } public void onDeletion(int i, Clustering clustering, Row.Deletion merged, Row.Deletion original) { } public void onComplexDeletion(int i, Clustering clustering, ColumnMetadata column, DeletionTime merged, DeletionTime original) { } public void onCell(int i, Clustering clustering, Cell merged, Cell original) { if (merged != null && !merged.equals(original)) toInsert.addCell(merged); if (merged == null || (original != null && shouldCleanupOldValue(original, merged))) toRemove.addCell(original); } }; Rows.diff(diffListener, updated, existing); Row oldRow = toRemove.build(); Row newRow = toInsert.build(); for (Index.Indexer indexer : indexers) indexer.updateRow(oldRow, newRow); } public void commit() { for (Index.Indexer indexer : indexers) indexer.finish(); } private boolean shouldCleanupOldValue(Cell oldCell, Cell newCell) { // If either the value or timestamp is different, then we // should delete from the index. If not, then we can infer that // at least one of the cells is an ExpiringColumn and that the // difference is in the expiry time. In this case, we don't want to // delete the old value from the index as the tombstone we insert // will just hide the inserted value. // Completely identical cells (including expiring columns with // identical ttl & localExpirationTime) will not get this far due // to the oldCell.equals(newCell) in StandardUpdater.update return !Cells.valueEqual(oldCell, newCell) || oldCell.timestamp() != newCell.timestamp(); } } /** * A single-use transaction for updating indexes for a single partition during compaction where the only * operation is to merge rows * TODO : make this smarter at batching updates so we can use a single transaction to process multiple rows in * a single partition */ private static final class IndexGCTransaction implements CompactionTransaction { private final DecoratedKey key; private final RegularAndStaticColumns columns; private final Keyspace keyspace; private final int versions; private final int nowInSec; private final Collection indexes; private Row[] rows; private IndexGCTransaction(DecoratedKey key, RegularAndStaticColumns columns, Keyspace keyspace, int versions, int nowInSec, Collection indexes) { this.key = key; this.columns = columns; this.keyspace = keyspace; this.versions = versions; this.indexes = indexes; this.nowInSec = nowInSec; } public void start() { if (versions > 0) rows = new Row[versions]; } public void onRowMerge(Row merged, Row... versions) { // Diff listener constructs rows representing deltas between the merged and original versions // These delta rows are then passed to registered indexes for removal processing final Row.Builder[] builders = new Row.Builder[versions.length]; RowDiffListener diffListener = new RowDiffListener() { public void onPrimaryKeyLivenessInfo(int i, Clustering clustering, LivenessInfo merged, LivenessInfo original) { if (original != null && (merged == null || !merged.isLive(nowInSec))) getBuilder(i, clustering).addPrimaryKeyLivenessInfo(original); } public void onDeletion(int i, Clustering clustering, Row.Deletion merged, Row.Deletion original) { } public void onComplexDeletion(int i, Clustering clustering, ColumnMetadata column, DeletionTime merged, DeletionTime original) { } public void onCell(int i, Clustering clustering, Cell merged, Cell original) { if (original != null && (merged == null || !merged.isLive(nowInSec))) getBuilder(i, clustering).addCell(original); } private Row.Builder getBuilder(int index, Clustering clustering) { if (builders[index] == null) { builders[index] = BTreeRow.sortedBuilder(); builders[index].newRow(clustering); } return builders[index]; } }; Rows.diff(diffListener, merged, versions); for (int i = 0; i < builders.length; i++) if (builders[i] != null) rows[i] = builders[i].build(); } public void commit() { if (rows == null) return; try (WriteContext ctx = keyspace.getWriteHandler().createContextForIndexing()) { for (Index index : indexes) { Index.Indexer indexer = index.indexerFor(key, columns, nowInSec, ctx, Type.COMPACTION); if (indexer == null) continue; indexer.begin(); for (Row row : rows) if (row != null) indexer.removeRow(row); indexer.finish(); } } } } /** * A single-use transaction for updating indexes for a single partition during cleanup, where * partitions and rows are only removed * TODO : make this smarter at batching updates so we can use a single transaction to process multiple rows in * a single partition */ private static final class CleanupGCTransaction implements CleanupTransaction { private final DecoratedKey key; private final RegularAndStaticColumns columns; private final Keyspace keyspace; private final int nowInSec; private final Collection indexes; private Row row; private DeletionTime partitionDelete; private CleanupGCTransaction(DecoratedKey key, RegularAndStaticColumns columns, Keyspace keyspace, int nowInSec, Collection indexes) { this.key = key; this.columns = columns; this.keyspace = keyspace; this.indexes = indexes; this.nowInSec = nowInSec; } public void start() { } public void onPartitionDeletion(DeletionTime deletionTime) { partitionDelete = deletionTime; } public void onRowDelete(Row row) { this.row = row; } public void commit() { if (row == null && partitionDelete == null) return; try (WriteContext ctx = keyspace.getWriteHandler().createContextForIndexing()) { for (Index index : indexes) { Index.Indexer indexer = index.indexerFor(key, columns, nowInSec, ctx, Type.CLEANUP); if (indexer == null) continue; indexer.begin(); if (partitionDelete != null) indexer.partitionDelete(partitionDelete); if (row != null) indexer.removeRow(row); indexer.finish(); } } } } private void executeBlocking(Callable task, FutureCallback callback) { if (null != task) { ListenableFuture f = blockingExecutor.submit(task); if (callback != null) Futures.addCallback(f, callback, MoreExecutors.directExecutor()); FBUtilities.waitOnFuture(f); } } private void executeAllBlocking(Stream indexers, Function> function, FutureCallback callback) { if (function == null) { logger.error("failed to flush indexes: {} because flush task is missing.", indexers); return; } List> waitFor = new ArrayList<>(); indexers.forEach(indexer -> { Callable task = function.apply(indexer); if (null != task) { ListenableFuture f = blockingExecutor.submit(task); if (callback != null) Futures.addCallback(f, callback, MoreExecutors.directExecutor()); waitFor.add(f); } }); FBUtilities.waitOnFutures(waitFor); } public void handleNotification(INotification notification, Object sender) { if (!indexes.isEmpty() && notification instanceof SSTableAddedNotification) { SSTableAddedNotification notice = (SSTableAddedNotification) notification; // SSTables asociated to a memtable come from a flush, so their contents have already been indexed if (!notice.memtable().isPresent()) buildIndexesBlocking(Lists.newArrayList(notice.added), indexes.values() .stream() .filter(Index::shouldBuildBlocking) .collect(Collectors.toSet()), false); } } @VisibleForTesting public static void shutdownAndWait(long timeout, TimeUnit units) throws InterruptedException, TimeoutException { shutdown(asyncExecutor, blockingExecutor); awaitTermination(timeout, units, asyncExecutor, blockingExecutor); } }