com.palantir.atlasdb.keyvalue.api.SweepResults Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of atlasdb-api Show documentation
Palantir open source project
There is a newer version: 0.1152.0
/*
 * (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.keyvalue.api;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.palantir.atlasdb.encoding.PtBytes;
import java.util.Optional;
import javax.annotation.Nullable;
import org.immutables.value.Value;

@JsonDeserialize(as = ImmutableSweepResults.class)
@JsonSerialize(as = ImmutableSweepResults.class)
@Value.Immutable
public abstract class SweepResults {

    @Nullable
    @JsonProperty("previousStartRow")
    protected abstract byte[] getPreviousStartRowNullable();

    @Nullable
    @JsonProperty("nextStartRow")
    protected abstract byte[] getNextStartRowNullable();

    @JsonIgnore
    public Optional getPreviousStartRow() {
        return Optional.ofNullable(getPreviousStartRowNullable());
    }

    @JsonIgnore
    public Optional getNextStartRow() {
        return Optional.ofNullable(getNextStartRowNullable());
    }

    /**
     * The approximate number of (cell, timestamp) pairs examined.
     */
    public abstract long getCellTsPairsExamined();

    /**
     * The number of (cell, timestamp) pairs deleted.
     */
    public abstract long getStaleValuesDeleted();

    /**
     * The minimum sweep timestamp while sweeping this table.
     */
    public abstract long getMinSweptTimestamp();

    /**
     * Time spent sweeping this iteration in milliseconds.
     */
    public abstract long getTimeInMillis();

    /**
     * Time in milliseconds when we started sweeping this table.
     */
    @Value.Auxiliary
    public abstract long getTimeSweepStarted();

    @JsonIgnore
    public long getTimeElapsedSinceStartedSweeping() {
        return System.currentTimeMillis() - getTimeSweepStarted();
    }

    /**
     * Returns a new {@link SweepResults} representing cumulative results from this instance and {@code other}.
     * The operation is commutative.
     */
    public SweepResults accumulateWith(SweepResults other) {
        return SweepResults.builder()
                .nextStartRow(maxRowOptional(getNextStartRow(), other.getNextStartRow()))
                .cellTsPairsExamined(getCellTsPairsExamined() + other.getCellTsPairsExamined())
                .staleValuesDeleted(getStaleValuesDeleted() + other.getStaleValuesDeleted())
                .minSweptTimestamp(Math.min(getMinSweptTimestamp(), other.getMinSweptTimestamp()))
                .timeInMillis(getTimeInMillis() + other.getTimeInMillis())
                .timeSweepStarted(Math.min(getTimeSweepStarted(), other.getTimeSweepStarted()))
                .build();
    }

    private Optional maxRowOptional(Optional fst, Optional snd) {
        return fst.flatMap(row1 -> snd.map(row2 -> PtBytes.BYTES_COMPARATOR.max(row1, row2)));
    }

    public static SweepResults.Builder builder() {
        return new Builder();
    }

    public static SweepResults createEmptySweepResultWithMoreToSweep() {
        return createEmptySweepResult(Optional.of(PtBytes.EMPTY_BYTE_ARRAY));
    }

    public static SweepResults createEmptySweepResultWithNoMoreToSweep() {
        return createEmptySweepResult(Optional.empty());
    }

    public static SweepResults createEmptySweepResult(Optional startRow) {
        return builder()
                .cellTsPairsExamined(0)
                .staleValuesDeleted(0)
                .minSweptTimestamp(Long.MAX_VALUE)
                .nextStartRow(startRow)
                .timeInMillis(0)
                .timeSweepStarted(System.currentTimeMillis())
                .build();
    }

    public static class Builder extends ImmutableSweepResults.Builder {
        public Builder previousStartRow(Optional previousStartRow) {
            return this.previousStartRowNullable(previousStartRow.orElse(null));
        }

        public Builder nextStartRow(Optional startRow) {
            return this.nextStartRowNullable(startRow.orElse(null));
        }
    }
}