Field Detail

• request

  protected CompactionRequest request

Constructor Detail

• CompactionContext

  public CompactionContext()

Method Detail

• preSelect

  public abstract List<StoreFile> preSelect(List<StoreFile> filesCompacting)

  Called before coprocessor preCompactSelection and should filter the candidates for coprocessor; i.e. exclude the files that definitely cannot be compacted at this time.

  Parameters:

  filesCompacting - files currently compacting

  Returns:

  the list of files that can theoretically be compacted.

• select

  public abstract boolean select(List<StoreFile> filesCompacting,
               boolean isUserCompaction,
               boolean mayUseOffPeak,
               boolean forceMajor)
                          throws IOException

  Called to select files for compaction. Must fill in the request field if successful.

  Parameters:

  filesCompacting - Files currently being compacted by other compactions.

  isUserCompaction - Whether this is a user compaction.

  mayUseOffPeak - Whether the underlying policy may assume it's off-peak hours.

  forceMajor - Whether to force major compaction.

  Returns:

  Whether the selection succeeded. Selection may be empty and lead to no compaction.

  Throws:

  IOException

• forceSelect

  public void forceSelect(CompactionRequest request)

  Forces external selection to be applied for this compaction.

  Parameters:

  request - The pre-cooked request with selection and other settings.

• compact

  public abstract List<org.apache.hadoop.fs.Path> compact(CompactionThroughputController throughputController)
                                                   throws IOException

  Runs the compaction based on current selection. select/forceSelect must have been called.

  Returns:

  The new file paths resulting from compaction.

  Throws:

  IOException

• compact

  public abstract List<org.apache.hadoop.fs.Path> compact(CompactionThroughputController throughputController,
                                        User user)
                                                   throws IOException

  Throws:

  IOException

• getRequest

  public CompactionRequest getRequest()

• hasSelection

  public boolean hasSelection()