io.cdap.wrangler.store.upgrade

Class UpgradeStore

java.lang.Object

io.cdap.wrangler.store.upgrade.UpgradeStore

public class UpgradeStore
extends Object

Upgrade store to store upgrade information for each namespace, Use system namespace to track the overall upgrade status. This upgrade store can be used as a general purpose for app upgrade: it has primary key as [namespace][namespace-generation][entity-type] and value [upgrade-ts-millis][upgrade-state] upgrade state is a serialized string which represents the overall upgrade information and status

Field Summary

Fields

Modifier and Type	Field and Description
static io.cdap.cdap.spi.data.table.StructuredTableSpecification	UPGRADE_TABLE_SPEC

Constructor Summary

Constructors

Constructor and Description
UpgradeStore(io.cdap.cdap.spi.data.transaction.TransactionRunner transactionRunner)

Method Summary

Modifier and Type	Method and Description
UpgradeState	getEntityUpgradeState(NamespaceSummary namespace, UpgradeEntityType type) Checks whether an entity type is upgrade complete in a namespace
UpgradeState	getEntityUpgradeState(UpgradeEntityType type) Get the upgrade state
long	initializeAndRetrieveUpgradeTimestampMillis(UpgradeEntityType type, long timestampMillis, UpgradeState preUpgradeState) Initialize the upgrade timestamp and state for the given upgrade types if not there and return the upgrade timestamp.
void	setEntityUpgradeState(NamespaceSummary namespace, UpgradeEntityType type, UpgradeState upgradeState) Set the upgrade complete status for the entity type in a namespace
void	setEntityUpgradeState(UpgradeEntityType type, UpgradeState upgradeState) Set the upgrade complete status for the entity type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UPGRADE_TABLE_SPEC

public static final io.cdap.cdap.spi.data.table.StructuredTableSpecification UPGRADE_TABLE_SPEC

Constructor Detail

UpgradeStore

public UpgradeStore(io.cdap.cdap.spi.data.transaction.TransactionRunner transactionRunner)

Method Detail

initializeAndRetrieveUpgradeTimestampMillis

public long initializeAndRetrieveUpgradeTimestampMillis(UpgradeEntityType type,
                                                        long timestampMillis,
                                                        UpgradeState preUpgradeState)

Initialize the upgrade timestamp and state for the given upgrade types if not there and return the upgrade timestamp. This method should be called before any upgrade starts. The upgrade will only operate on entities created before this timestamp.

Parameters:

type - the upgrade entity type

timestampMillis - the upgrade timestamp in millis

preUpgradeState - the state before upgrade

Returns:

the upgrade timestamp

setEntityUpgradeState

public void setEntityUpgradeState(UpgradeEntityType type,
                                  UpgradeState upgradeState)

Set the upgrade complete status for the entity type

setEntityUpgradeState

public void setEntityUpgradeState(NamespaceSummary namespace,
                                  UpgradeEntityType type,
                                  UpgradeState upgradeState)

Set the upgrade complete status for the entity type in a namespace

Parameters:

namespace - namespace that completed upgrade

getEntityUpgradeState

@Nullable
public UpgradeState getEntityUpgradeState(UpgradeEntityType type)

Get the upgrade state

getEntityUpgradeState

public UpgradeState getEntityUpgradeState(NamespaceSummary namespace,
                                          UpgradeEntityType type)

Checks whether an entity type is upgrade complete in a namespace