org.voltdb.sysprocs.MigrateRowsAcked_SP Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of voltdb Show documentation
VoltDB server libraries
There is a newer version: 10.1.1
/* This file is part of VoltDB.
 * Copyright (C) 2008-2020 VoltDB Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with VoltDB.  If not, see .
 */

package org.voltdb.sysprocs;

import java.util.List;
import java.util.Map;

import org.voltcore.logging.VoltLogger;
import org.voltdb.DependencyPair;
import org.voltdb.ParameterSet;
import org.voltdb.SystemProcedureExecutionContext;
import org.voltdb.VoltSystemProcedure;
import org.voltdb.VoltTable;
import org.voltdb.VoltTable.ColumnInfo;
import org.voltdb.dtxn.TransactionState;
import org.voltdb.exceptions.MispartitionedException;
import org.voltdb.VoltType;

/**
 * This is the clean up leg of Migrating table rows off of the partition
 * through the Export path. When the rows have been acknowledged by
 * Export, the rows can be removed from the Persistent Table.
  */
public class MigrateRowsAcked_SP extends VoltSystemProcedure {

    VoltLogger exportLog = new VoltLogger("EXPORT");
    @Override
    public long[] getPlanFragmentIds() {
        return new long[]{};
    }

    /**
     * This single-partition sysproc has no special fragments
     */
    @Override
    public DependencyPair executePlanFragment(
            Map> dependencies, long fragmentId,
            ParameterSet params, SystemProcedureExecutionContext context) {
        return null;
    }

    /**
    *
    * @param ctx execution context
    * @param partitionParam partition parameter
    * @param tableName Name of table that can have rows deleted
    * @param deletableTxnId All rows with this transaction or the first transaction before this can be deleted
    * @return
    */
    public VoltTable run(SystemProcedureExecutionContext context, int partitionParam, String tableName, long deletableTxnId, int partitionId)
    {
        VoltTable result = new VoltTable(new ColumnInfo(MigrateRowsDeleterNT.ROWS_TO_BE_DELETED, VoltType.BIGINT));
        // mis-partitioned, possibly in cluster grow and shrink.
        if (m_site.getCorrespondingPartitionId() != partitionId) {
            throw new MispartitionedException();
        }
        final TransactionState txnState = m_runner.getTxnState();
        boolean txnRemainingDeleted = context.getSiteProcedureConnection().deleteMigratedRows(
                txnState.txnId, txnState.m_spHandle, txnState.uniqueId,
                tableName, deletableTxnId);
        if (exportLog.isDebugEnabled()) {
            exportLog.debug(String.format("MigrateRowsAcked_SP: remaining %s on table %s, txnId: %d",
                    Boolean.toString(txnRemainingDeleted), tableName, deletableTxnId));
        }
        result.addRow(txnRemainingDeleted ? 1: 0);
        return result;
    }
}