Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.impl.store.raw.data.CopyRowsOperation

Modifier and Type	Field and Description
protected int	destSlot
protected int	num_rows
protected transient ByteArray	preparedLog
protected int[]	recordIds
protected int[]	reservedSpace

Access	Constructor and Description
pack-priv	CopyRowsOperation(RawTransaction t, BasePage destPage, BasePage srcPage, int destSlot, int num_rows, int srcSlot, int[] recordIds)
public	CopyRowsOperation()

Method Summary

Modifier and Type	Method and Description
public void	doMe(Transaction the Transaction xact, LogInstant the log instant of this operation instant, LimitObjectInput optional data in) Implements org.apache.derby.iapi.store.raw.Loggable.doMe. Apply the change indicated by this operation and optional data.
public ByteArray	getPreparedLog() Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.getPreparedLog. Implements org.apache.derby.iapi.store.raw.Loggable.getPreparedLog. The log operations are responsible to create the ByteArray, and the log operations should write out any optional data for the change to the ByteArray.
public int	getTypeFormatId() Implements org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId. Return my format identifier.
public void	readExternal(ObjectInput the stream to read data from in order to restore the object in) Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.readExternal. Implements java.io.Externalizable.readExternal. Read this in
public void	restoreMe(Transaction the Transaction doing the rollback xact, BasePage the page to rollback changes on undoPage, LogInstant the log instant of this (PageUndo) operation CLRInstant, LimitObjectInput optional data for the rollback operation in) Implements abstract org.apache.derby.impl.store.raw.data.PageBasicOperation.restoreMe. restore the before image of the page
public String	toString() Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.toString. DEBUG: Print self.
public void	undoMe(Transaction the Transaction doing the rollback xact, BasePage the page to rollback changes on undoPage, LogInstant the log instant of this (PageUndo) operation CLRInstant, LimitObjectInput optional data for the rollback operation in) Implements abstract org.apache.derby.impl.store.raw.data.PhysicalPageOperation.undoMe. to undo this operation, purge all records that were copied over.
public void	writeExternal(ObjectOutput the stream to write the object to out) Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.writeExternal. Implements java.io.Externalizable.writeExternal. The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.
private void	writeOptionalDataToBuffer(RawTransaction t, BasePage srcPage, int srcSlot) Write the rows that are to be copied into this page

Inherited from org.apache.derby.impl.store.raw.data.PhysicalPageOperation:: generateUndo

destSlot	back to summary
protected int destSlot

num_rows	back to summary
protected int num_rows

preparedLog	back to summary
protected transient ByteArray preparedLog

recordIds	back to summary
protected int[] recordIds

reservedSpace	back to summary
protected int[] reservedSpace

CopyRowsOperation	back to summary
pack-priv CopyRowsOperation(RawTransaction t, BasePage destPage, BasePage srcPage, int destSlot, int num_rows, int srcSlot, int[] recordIds) throws StandardException

CopyRowsOperation	back to summary
public CopyRowsOperation()

Method Detail

doMe back to summary

doMe	back to summary
public void doMe(Transaction xact, LogInstant instant, LimitObjectInput in) throws StandardException, IOException Implements org.apache.derby.iapi.store.raw.Loggable.doMe. Doc from org.apache.derby.iapi.store.raw.Loggable.doMe. Apply the change indicated by this operation and optional data. If this method fail, the system will be shut down because the log record has already been written to disk. Moreover, the log record will be replayed during recovery and this doMe method will be called on the same page again, so if it fails again, recovery will fail and the database cannot be started. So it is very important to make sure that every resource you need, such as disk space, has been acquired before the logAndDo method is called! This method cannot acquire any resource (like latching of a page) since it is called underneath the logging system, ie., the log record has already been written to the log stream. The available() method of in indicates how much data can be read, i.e. how much was originally written. Parameters xact:Transaction the Transaction instant:LogInstant the log instant of this operation in:LimitObjectInput optional data Exceptions StandardException: Standard Derby error policy. IOException: Can be thrown by any of the methods of ObjectInput. See Also `org.apache.derby.iapi.store.raw.Loggable#doMe`

public void doMe(Transaction xact, LogInstant instant, LimitObjectInput in) throws StandardException, IOException

Implements org.apache.derby.iapi.store.raw.Loggable.doMe.

Doc from org.apache.derby.iapi.store.raw.Loggable.doMe.

Apply the change indicated by this operation and optional data. If this method fail, the system will be shut down because the log record has already been written to disk. Moreover, the log record will be replayed during recovery and this doMe method will be called on the same page again, so if it fails again, recovery will fail and the database cannot be started. So it is very important to make sure that every resource you need, such as disk space, has been acquired before the logAndDo method is called!
This method cannot acquire any resource (like latching of a page) since it is called underneath the logging system, ie., the log record has already been written to the log stream.

The available() method of in indicates how much data can be read, i.e. how much was originally written.

Parameters

xact:Transaction: the Transaction
instant:LogInstant: the log instant of this operation
in:LimitObjectInput: optional data

Exceptions

StandardException:: Standard Derby error policy.
IOException:: Can be thrown by any of the methods of ObjectInput.

getPreparedLog	back to summary
public ByteArray getPreparedLog() Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.getPreparedLog. Implements org.apache.derby.iapi.store.raw.Loggable.getPreparedLog. Doc from org.apache.derby.iapi.store.raw.Loggable.getPreparedLog. The log operations are responsible to create the ByteArray, and the log operations should write out any optional data for the change to the ByteArray. The ByteArray can be prepared when the log operation is constructed, or it can be prepared when getPreparedLog() is called. Called by the log manager to allow the log operation to pass the buffer which contains optional data that will be available in to doMe() methods.

getPreparedLog

back to summary

public ByteArray getPreparedLog()

Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.getPreparedLog.

Implements org.apache.derby.iapi.store.raw.Loggable.getPreparedLog.

Doc from org.apache.derby.iapi.store.raw.Loggable.getPreparedLog.

The log operations are responsible to create the ByteArray, and the log operations should write out any optional data for the change to the ByteArray. The ByteArray can be prepared when the log operation is constructed, or it can be prepared when getPreparedLog() is called. Called by the log manager to allow the log operation to pass the buffer which contains optional data that will be available in to doMe() methods.

getTypeFormatId	back to summary
public int getTypeFormatId() Implements org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId. Return my format identifier. Returns:int Doc from org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId. The identifier. (A UUID stuffed in an array of 16 bytes).

getTypeFormatId

back to summary

public int getTypeFormatId()

Implements org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId.

Return my format identifier.

Returns:int

Doc from org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId.

The identifier. (A UUID stuffed in an array of 16 bytes).

readExternal	back to summary
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.readExternal. Implements java.io.Externalizable.readExternal. Read this in Parameters in:ObjectInput Doc from java.io.Externalizable.readExternal. the stream to read data from in order to restore the object Exceptions IOException: error reading from log stream ClassNotFoundException: log stream corrupted

readExternal

back to summary

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.readExternal.

Implements java.io.Externalizable.readExternal.

Read this in

Parameters

in:ObjectInput

Doc from java.io.Externalizable.readExternal.

the stream to read data from in order to restore the object

Exceptions

IOException:: error reading from log stream
ClassNotFoundException:: log stream corrupted

restoreMe	back to summary
public void restoreMe(Transaction xact, BasePage undoPage, LogInstant CLRInstant, LimitObjectInput in) throws StandardException, IOException Implements abstract org.apache.derby.impl.store.raw.data.PageBasicOperation.restoreMe. restore the before image of the page Parameters xact:Transaction Doc from org.apache.derby.impl.store.raw.data.PageBasicOperation.restoreMe. the Transaction doing the rollback undoPage:BasePage Doc from org.apache.derby.impl.store.raw.data.PageBasicOperation.restoreMe. the page to rollback changes on CLRInstant:LogInstant Doc from org.apache.derby.impl.store.raw.data.PageBasicOperation.restoreMe. the log instant of this (PageUndo) operation in:LimitObjectInput Doc from org.apache.derby.impl.store.raw.data.PageBasicOperation.restoreMe. optional data for the rollback operation Exceptions StandardException: Standard Derby Error Policy IOException: problem reading the complete log record from the input stream

toString	back to summary
public String toString() Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.toString. DEBUG: Print self. Returns:String Doc from java.lang.Object.toString. a string representation of the object

toString

back to summary

public String toString()

Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.toString.

DEBUG: Print self.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

undoMe	back to summary
public void undoMe(Transaction xact, BasePage undoPage, LogInstant CLRInstant, LimitObjectInput in) throws StandardException, IOException Implements abstract org.apache.derby.impl.store.raw.data.PhysicalPageOperation.undoMe. to undo this operation, purge all records that were copied over. Parameters xact:Transaction Doc from org.apache.derby.impl.store.raw.data.PhysicalPageOperation.undoMe. the Transaction doing the rollback undoPage:BasePage Doc from org.apache.derby.impl.store.raw.data.PhysicalPageOperation.undoMe. the page to rollback changes on CLRInstant:LogInstant Doc from org.apache.derby.impl.store.raw.data.PhysicalPageOperation.undoMe. the log instant of this (PageUndo) operation in:LimitObjectInput Doc from org.apache.derby.impl.store.raw.data.PhysicalPageOperation.undoMe. optional data for the rollback operation Exceptions StandardException: Standard Derby error policy IOException: Can be thrown by any of the methods of ObjectInput. See Also `PhysicalPageOperation#undoMe`

writeExternal	back to summary
public void writeExternal(ObjectOutput out) throws IOException Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.writeExternal. Implements java.io.Externalizable.writeExternal. Doc from java.io.Externalizable.writeExternal. The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays. Parameters out:ObjectOutput the stream to write the object to Exceptions IOException: Includes any I/O exceptions that may occur

writeExternal

back to summary

public void writeExternal(ObjectOutput out) throws IOException

Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.writeExternal.

Implements java.io.Externalizable.writeExternal.

Doc from java.io.Externalizable.writeExternal.

The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Parameters

out:ObjectOutput: the stream to write the object to

Exceptions

IOException:: Includes any I/O exceptions that may occur

writeOptionalDataToBuffer	back to summary
private void writeOptionalDataToBuffer(RawTransaction t, BasePage srcPage, int srcSlot) throws StandardException, IOException Write the rows that are to be copied into this page Exceptions StandardException: Standard Derby policy. IOException: Can be thrown by any of the methods of ObjectOutput.

public Class CopyRowsOperation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail