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:
Externalizable
,Serializable
,Formatable
,TypedFormat
,Loggable
,RePreparable
,Undoable
USE WITH EXTREME Caution: Purge records from a Page.
Represents purging of a range of rows from the page.
- See Also:
-
Field Summary
FieldsFields 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
ConstructorsConstructorDescriptionPurgeOperation
(RawTransaction t, BasePage page, int slot, int num_rows, int[] recordIds, boolean needDataLogged) -
Method Summary
Modifier and TypeMethodDescriptionvoid
doMe
(Transaction xact, LogInstant instant, LimitObjectInput in) Apply the purge operation to the page.the default for optional data is set to null.int
Return my format identifier.void
Read this invoid
restoreMe
(Transaction xact, BasePage undoPage, LogInstant CLRInstant, LimitObjectInput in) restore the before image of the pagetoString()
DEBUG: Print self.void
undoMe
(Transaction xact, BasePage undoPage, LogInstant CLRInstant, LimitObjectInput in) Undo the purge operation on the page.void
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 Details
-
slot
protected int slot -
num_rows
protected int num_rows -
recordIds
protected int[] recordIds -
preparedLog
-
-
Constructor Details
-
PurgeOperation
PurgeOperation(RawTransaction t, BasePage page, int slot, int num_rows, int[] recordIds, boolean needDataLogged) throws StandardException - Throws:
StandardException
-
PurgeOperation
public PurgeOperation()
-
-
Method Details
-
writeExternal
- Specified by:
writeExternal
in interfaceExternalizable
- Overrides:
writeExternal
in classPageBasicOperation
- Throws:
IOException
-
readExternal
Read this in- Specified by:
readExternal
in interfaceExternalizable
- Overrides:
readExternal
in classPageBasicOperation
- Throws:
IOException
- error reading from log streamClassNotFoundException
- 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, IOException Apply the purge operation to the page.- Parameters:
xact
- the Transactioninstant
- the log instant of this operationin
- optional data- Throws:
IOException
- Can be thrown by any of the methods of ObjectInput.StandardException
- Standard Derby policy.- See Also:
-
undoMe
public void undoMe(Transaction xact, BasePage undoPage, LogInstant CLRInstant, LimitObjectInput in) throws StandardException, 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:
IOException
- Can be thrown by any of the methods of ObjectInput.StandardException
- Standard Derby policy.- See Also:
-
restoreMe
public void restoreMe(Transaction xact, BasePage undoPage, LogInstant CLRInstant, LimitObjectInput in) throws StandardException, 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 PolicyIOException
- problem reading the complete log record from the input stream
-
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, IOException Write out the purged record from the page. Used for undo only.- Throws:
IOException
- Can be thrown by any of the methods of ObjectOutput.StandardException
- Standard Derby policy.
-
toString
DEBUG: Print self.- Overrides:
toString
in classPageBasicOperation
-