Class PurgeOperation
- java.lang.Object
-
- org.apache.derby.impl.store.raw.data.PageBasicOperation
-
- org.apache.derby.impl.store.raw.data.PhysicalPageOperation
-
- org.apache.derby.impl.store.raw.data.PurgeOperation
-
- All Implemented Interfaces:
java.io.Externalizable
,java.io.Serializable
,Formatable
,TypedFormat
,Loggable
,RePreparable
,Undoable
public final class PurgeOperation extends PhysicalPageOperation
USE WITH EXTREME Caution: Purge records from a Page. Represents purging of a range of rows from the page.- See Also:
Page.purgeAtSlot(int, int, boolean)
, Serialized Form
Format ID LOGOP_PURGE the formatId is written by FormatIdOutputStream when this object is written out by writeObject Purpose purge num_rows from the page Upgrade Disk Layout PagePhysicalOperation the super class slot(CompressedInt) the slot to start purging num_rows(CompressedInt) number of rows rows to purge recordIds(CompressedInt[num_rows]) the recordIds of the purged rows OptionalData the before images of the rows that were purged
-
-
Field Summary
Fields Modifier and Type Field Description protected int
num_rows
protected ByteArray
preparedLog
protected int[]
recordIds
protected int
slot
-
Fields inherited from class org.apache.derby.impl.store.raw.data.PageBasicOperation
containerHdl, foundHere, page
-
Fields inherited from interface org.apache.derby.iapi.store.raw.Loggable
ABORT, BI_LOG, CHECKSUM, COMMIT, COMPENSATION, FILE_RESOURCE, FIRST, LAST, PREPARE, RAWSTORE, XA_NEEDLOCK
-
-
Constructor Summary
Constructors Constructor Description PurgeOperation()
PurgeOperation(RawTransaction t, BasePage page, int slot, int num_rows, int[] recordIds, boolean needDataLogged)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
doMe(Transaction xact, LogInstant instant, LimitObjectInput in)
Apply the purge operation to the page.ByteArray
getPreparedLog()
the default for optional data is set to null.int
getTypeFormatId()
Return my format identifier.void
readExternal(java.io.ObjectInput in)
Read this invoid
restoreMe(Transaction xact, BasePage undoPage, LogInstant CLRInstant, LimitObjectInput in)
restore the before image of the pagejava.lang.String
toString()
DEBUG: Print self.void
undoMe(Transaction xact, BasePage undoPage, LogInstant CLRInstant, LimitObjectInput in)
Undo the purge operation on the page.void
writeExternal(java.io.ObjectOutput out)
private void
writeOptionalDataToBuffer(RawTransaction t, boolean needDataLogged)
Write out the purged record from the page.-
Methods inherited from class org.apache.derby.impl.store.raw.data.PhysicalPageOperation
generateUndo
-
Methods inherited from class org.apache.derby.impl.store.raw.data.PageBasicOperation
findpage, getPage, getPageForRedoRecovery, getPageId, getPageVersion, group, needsRedo, reclaimPrepareLocks, releaseResource, resetPageNumber
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.derby.iapi.store.raw.Loggable
group, needsRedo, releaseResource
-
-
-
-
Field Detail
-
slot
protected int slot
-
num_rows
protected int num_rows
-
recordIds
protected int[] recordIds
-
preparedLog
protected transient ByteArray preparedLog
-
-
Constructor Detail
-
PurgeOperation
PurgeOperation(RawTransaction t, BasePage page, int slot, int num_rows, int[] recordIds, boolean needDataLogged) throws StandardException
- Throws:
StandardException
-
PurgeOperation
public PurgeOperation()
-
-
Method Detail
-
writeExternal
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
- Specified by:
writeExternal
in interfacejava.io.Externalizable
- Overrides:
writeExternal
in classPageBasicOperation
- Throws:
java.io.IOException
-
readExternal
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
Read this in- Specified by:
readExternal
in interfacejava.io.Externalizable
- Overrides:
readExternal
in classPageBasicOperation
- Throws:
java.io.IOException
- error reading from log streamjava.lang.ClassNotFoundException
- log stream corrupted
-
getTypeFormatId
public int getTypeFormatId()
Return my format identifier.- Returns:
- The identifier. (A UUID stuffed in an array of 16 bytes).
-
doMe
public void doMe(Transaction xact, LogInstant instant, LimitObjectInput in) throws StandardException, java.io.IOException
Apply the purge operation to the page.- Parameters:
xact
- the Transactioninstant
- the log instant of this operationin
- optional data- Throws:
java.io.IOException
- Can be thrown by any of the methods of ObjectInput.StandardException
- Standard Derby policy.- See Also:
Loggable.doMe(org.apache.derby.iapi.store.raw.Transaction, org.apache.derby.iapi.store.raw.log.LogInstant, org.apache.derby.iapi.services.io.LimitObjectInput)
-
undoMe
public void undoMe(Transaction xact, BasePage undoPage, LogInstant CLRInstant, LimitObjectInput in) throws StandardException, java.io.IOException
Undo the purge operation on the page.- Specified by:
undoMe
in classPhysicalPageOperation
- Parameters:
xact
- the Transaction doing the rollbackundoPage
- the page to rollback changes onCLRInstant
- the log instant of this (PageUndo) operationin
- optional data for the rollback operation- Throws:
java.io.IOException
- Can be thrown by any of the methods of ObjectInput.StandardException
- Standard Derby policy.- See Also:
PhysicalPageOperation.undoMe(org.apache.derby.iapi.store.raw.Transaction, org.apache.derby.impl.store.raw.data.BasePage, org.apache.derby.iapi.store.raw.log.LogInstant, org.apache.derby.iapi.services.io.LimitObjectInput)
-
restoreMe
public void restoreMe(Transaction xact, BasePage undoPage, LogInstant CLRInstant, LimitObjectInput in) throws StandardException, java.io.IOException
restore the before image of the page- Specified by:
restoreMe
in classPageBasicOperation
- Parameters:
xact
- the Transaction doing the rollbackundoPage
- the page to rollback changes onCLRInstant
- the log instant of this (PageUndo) operationin
- optional data for the rollback operation- Throws:
StandardException
- Standard Derby Error Policyjava.io.IOException
- problem reading the complete log record from the input stream
-
getPreparedLog
public ByteArray getPreparedLog()
Description copied from class:PageBasicOperation
the default for optional data is set to null. If an operation has optional data, the operation need to prepare the optional data for this method. WARNING: If a log operation extends this class, and the operation has optional data, it MUST overwrite this method to return a ByteArray that contains the optional data.- Specified by:
getPreparedLog
in interfaceLoggable
- Overrides:
getPreparedLog
in classPageBasicOperation
-
writeOptionalDataToBuffer
private void writeOptionalDataToBuffer(RawTransaction t, boolean needDataLogged) throws StandardException, java.io.IOException
Write out the purged record from the page. Used for undo only.- Throws:
java.io.IOException
- Can be thrown by any of the methods of ObjectOutput.StandardException
- Standard Derby policy.
-
toString
public java.lang.String toString()
DEBUG: Print self.- Overrides:
toString
in classPageBasicOperation
-
-