Class InsertOperation

java.lang.Object

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

org.apache.derby.impl.store.raw.data.LogicalPageOperation

org.apache.derby.impl.store.raw.data.InsertOperation

All Implemented Interfaces:

Externalizable, Serializable, Formatable, TypedFormat, Loggable, LogicalUndoable, RePreparable, Undoable

public final class InsertOperation
extends LogicalPageOperation

Represents an insert of a record onto a page.

See Also:

• Page.insertAtSlot(int, Object[], FormatableBitSet, LogicalUndo, byte, int)
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	doMeSlot
protected byte	insertFlag
protected ByteArray	preparedLog
protected int	startColumn	next column that need to be inserted.

Fields inherited from class LogicalPageOperation

recordId, undo

Fields inherited from class PageBasicOperation

containerHdl, foundHere, page

Fields inherited from interface Loggable

ABORT, BI_LOG, CHECKSUM, COMMIT, COMPENSATION, FILE_RESOURCE, FIRST, LAST, PREPARE, RAWSTORE, XA_NEEDLOCK

Constructor Summary

Constructors

Constructor	Description
InsertOperation()
InsertOperation(RawTransaction t, BasePage page, int slot, int recordId, Object[] row, FormatableBitSet validColumns, LogicalUndo undo, byte insertFlag, int startColumn, boolean isLongColumn, int realStartColumn, DynamicByteArrayOutputStream logBuffer, int realSpaceOnPage, int overflowThreshold)

Method Summary

Modifier and Type	Method	Description
void	doMe(Transaction xact, LogInstant instant, LimitObjectInput in)	Apply the change indicated by this operation and optional data.
int	getNextStartColumn()
ByteArray	getPreparedLog()	the default for optional data is set to null.
int	getTypeFormatId()	Return my format identifier.
void	readExternal(ObjectInput in)	Read this in
void	restoreLoggedRow(Object[] row, LimitObjectInput in)	Restore the row stored in the optional data of the log record.
void	restoreMe(Transaction xact, BasePage undoPage, LogInstant CLRinstant, LimitObjectInput in)	restore the before image of the page
String	toString()	DEBUG: Print self.
void	undoMe(Transaction xact, BasePage undoPage, int undoRecordId, LogInstant CLRInstant, LimitObjectInput in)	Undo the insert by simply marking the just inserted record as deleted.
void	writeExternal(ObjectOutput out)	Write this out.
private void	writeOptionalDataToBuffer(RawTransaction t, DynamicByteArrayOutputStream logBuffer, Object[] row, FormatableBitSet validColumns, boolean isLongColumn, int realStartColumn, int realSpaceOnPage, int overflowThreshold)	Writes out the row that is to be inserted as the optional data.

Methods inherited from class LogicalPageOperation

generateUndo, getContainer, getRecordHandle, reclaimPrepareLocks, resetRecordHandle

Methods inherited from class PageBasicOperation

findpage, getPage, getPageForRedoRecovery, getPageId, getPageVersion, group, needsRedo, releaseResource, resetPageNumber

Methods inherited from class Object

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

Methods inherited from interface Loggable

group, needsRedo, releaseResource

Field Details

doMeSlot

protected int doMeSlot

insertFlag

protected byte insertFlag

startColumn

protected transient int startColumn

next column that need to be inserted.

preparedLog

protected transient ByteArray preparedLog

Constructor Details

InsertOperation

InsertOperation(RawTransaction t,
 BasePage page,
 int slot,
 int recordId,
 Object[] row,
 FormatableBitSet validColumns,
 LogicalUndo undo,
 byte insertFlag,
 int startColumn,
 boolean isLongColumn,
 int realStartColumn,
 DynamicByteArrayOutputStream logBuffer,
 int realSpaceOnPage,
 int overflowThreshold)
         throws StandardException

Throws:

StandardException

InsertOperation

public InsertOperation()

Method Details

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Write this out.

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class LogicalPageOperation

Throws:

IOException - error writing to log stream

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Read this in

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class LogicalPageOperation

Throws:

IOException - error reading from log stream

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,
IOException

Description copied from interface: Loggable

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 - the Transaction

instant - the log instant of this operation

in - optional data

Throws:

IOException - Can be thrown by any of the methods of ObjectInput.

StandardException - Standard Derby policy.

See Also:

• Loggable.doMe(Transaction, LogInstant, LimitObjectInput)

undoMe

public void undoMe(Transaction xact,
 BasePage undoPage,
 int undoRecordId,
 LogInstant CLRInstant,
 LimitObjectInput in)
            throws StandardException,
IOException

Undo the insert by simply marking the just inserted record as deleted. All logical undo logic has already been taken care of by generateUndo.

Specified by:

undoMe in class LogicalPageOperation

Parameters:

xact - the Transaction doing the rollback

undoPage - the page to rollback changes on

undoRecordId - the recordId to rollback changes on

CLRInstant - the log instant of this (PageUndo) operation

in - optional data for the rollback operation

Throws:

IOException - Can be thrown by any of the methods of ObjectInput.

StandardException - Standard Derby policy.

See Also:

• LogicalPageOperation.undoMe(Transaction, BasePage, int, LogInstant, LimitObjectInput)

restoreLoggedRow

public void restoreLoggedRow(Object[] row,
 LimitObjectInput in)
                      throws StandardException,
IOException

Restore the row stored in the optional data of the log record.

Parameters:

row - an IN/OUT parameter, caller passed in the row with the correct column number and type, the log operation will restore the row with the optional data stored in the log record.

Throws:

IOException - error reading from log stream

StandardException - Standard Derby error policy

See Also:

• LogicalUndo

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 class PageBasicOperation

Parameters:

xact - the Transaction doing the rollback

undoPage - the page to rollback changes on

CLRinstant - the log instant of this (PageUndo) operation

in - optional data for the rollback operation

Throws:

StandardException - Standard Derby Error Policy

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 interface Loggable

Overrides:

getPreparedLog in class PageBasicOperation

getNextStartColumn

public int getNextStartColumn()

writeOptionalDataToBuffer

private void writeOptionalDataToBuffer(RawTransaction t,
 DynamicByteArrayOutputStream logBuffer,
 Object[] row,
 FormatableBitSet validColumns,
 boolean isLongColumn,
 int realStartColumn,
 int realSpaceOnPage,
 int overflowThreshold)
                                throws StandardException,
IOException

Writes out the row that is to be inserted as the optional data.

Throws:

IOException - Can be thrown by any of the methods of ObjectOutput

StandardException - Standard Derby policy.

toString

public String toString()

DEBUG: Print self.

Overrides:

toString in class PageBasicOperation