Class UpdateConstantAction

java.lang.Object

org.apache.derby.impl.sql.execute.WriteCursorConstantAction

org.apache.derby.impl.sql.execute.UpdateConstantAction

All Implemented Interfaces:

Externalizable, Serializable, Formatable, TypedFormat, ConstantAction

public class UpdateConstantAction
extends WriteCursorConstantAction

This class describes compiled constants that are passed into UpdateResultSets.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private long[]	autoincIncrement
(package private) RowLocation[]	autoincRowLocation	An array of row location objects (0 based), one for each column in the table.
(package private) int[]	changedColumnIds	This class implements Formatable.
private String[]	columnNames
(package private) String	identitySequenceUUIDString
(package private) int	numColumns
private boolean	positionedUpdate
private String	schemaName
private String	tableName

Fields inherited from class WriteCursorConstantAction

conglomId, deferred, heapSCOCI, indexCIDS, indexNames, indexSCOCIs, irgs, lockMode, singleRowSource, targetUUID

Fields inherited from interface ConstantAction

WHEN_MATCHED_THEN_DELETE, WHEN_MATCHED_THEN_UPDATE, WHEN_NOT_MATCHED_THEN_INSERT

Constructor Summary

Constructors

Constructor	Description
UpdateConstantAction()	Public niladic constructor.
UpdateConstantAction(TableDescriptor targetTableDesc, StaticCompiledOpenConglomInfo heapSCOCI, IndexRowGenerator[] irgs, long[] indexCIDS, StaticCompiledOpenConglomInfo[] indexSCOCIs, String[] indexNames, boolean deferred, UUID targetUUID, int lockMode, int[] changedColumnIds, FKInfo[] fkInfo, TriggerInfo triggerInfo, FormatableBitSet baseRowReadList, int[] baseRowReadMap, int[] streamStorableHeapColIds, int numColumns, boolean positionedUpdate, boolean singleRowSource, RowLocation[] autoincRowLocation, boolean underMerge, String identitySequenceUUIDString)	Make the ConstantAction for an UPDATE statement.

Method Summary

Modifier and Type	Method	Description
long	getAutoincIncrement(int i)	gets the increment value for a column.
(package private) RowLocation[]	getAutoincRowLocation()	gets the row location
String	getColumnName(int i)	gets the name of the desired column in the taget table.
(package private) String[]	getColumnNames()	get the array of column names in the target table.
String	getSchemaName()
String	getTableName()
int	getTypeFormatId()	Get the formatID which corresponds to this class.
boolean	hasAutoincrement()	Does the target table has autoincrement columns.
void	readExternal(ObjectInput in)	Read this object from a stream of stored objects.
void	writeExternal(ObjectOutput out)	Write this object to a stream of stored objects.

Methods inherited from class WriteCursorConstantAction

executeConstantAction, getBaseRowReadList, getBaseRowReadMap, getConglomerateId, getFKInfo, getIndexNameFromCID, getIndexNames, getProperty, getStreamStorableHeapColIds, getTargetProperties, getTriggerInfo, underMerge

Methods inherited from class Object

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

Field Details

changedColumnIds

int[] changedColumnIds

This class implements Formatable. But it is NOT used across either major or minor releases. It is only written persistently in stored prepared statements, not in the replication stage. SO, IT IS OK TO CHANGE ITS read/writeExternal.

positionedUpdate

private boolean positionedUpdate

numColumns

int numColumns

schemaName

private String schemaName

tableName

private String tableName

columnNames

private String[] columnNames

identitySequenceUUIDString

String identitySequenceUUIDString

autoincRowLocation

RowLocation[] autoincRowLocation

An array of row location objects (0 based), one for each column in the table. If the column is an autoincrement table then the array points to the row location of the column in SYSCOLUMNS. if not, then it contains null.

autoincIncrement

private long[] autoincIncrement

Constructor Details

UpdateConstantAction

public UpdateConstantAction()

Public niladic constructor. Needed for Formatable interface to work.

UpdateConstantAction

UpdateConstantAction(TableDescriptor targetTableDesc,
 StaticCompiledOpenConglomInfo heapSCOCI,
 IndexRowGenerator[] irgs,
 long[] indexCIDS,
 StaticCompiledOpenConglomInfo[] indexSCOCIs,
 String[] indexNames,
 boolean deferred,
 UUID targetUUID,
 int lockMode,
 int[] changedColumnIds,
 FKInfo[] fkInfo,
 TriggerInfo triggerInfo,
 FormatableBitSet baseRowReadList,
 int[] baseRowReadMap,
 int[] streamStorableHeapColIds,
 int numColumns,
 boolean positionedUpdate,
 boolean singleRowSource,
 RowLocation[] autoincRowLocation,
 boolean underMerge,
 String identitySequenceUUIDString)
              throws StandardException

Make the ConstantAction for an UPDATE statement.

Parameters:

targetTableDesc - descriptor for the table to be updated

heapSCOCI - StaticCompiledOpenConglomInfo for heap.

irgs - Index descriptors

indexCIDS - Conglomerate IDs of indices

indexSCOCIs - StaticCompiledOpenConglomInfos for indexes.

indexNames - Names of indices on this table for error reporting.

deferred - True means process as a deferred update.

targetUUID - UUID of target table

lockMode - The lock mode to use (row or table, see TransactionController)

changedColumnIds - Array of ids of changed columns

fkInfo - Array of structures containing foreign key info, if any (may be null)

triggerInfo - Array of structures containing trigger info, if any (may be null)

baseRowReadList - Map of columns read in. 1 based.

baseRowReadMap - BaseRowReadMap[heapColId]->ReadRowColumnId. (0 based)

streamStorableHeapColIds - Null for non rep. (0 based)

numColumns - Number of columns being read.

positionedUpdate - is this a positioned update

singleRowSource - Whether or not source is a single row source

autoincRowLocation - Array of rowlocations of autoincrement values in SYSCOLUMNS for each ai column.

underMerge - True if this is an action of a MERGE statement.

identitySequenceUUIDString - For 10.11 and higher, the handle on the sequence for the identity column

Throws:

StandardException

Method Details

hasAutoincrement

public boolean hasAutoincrement()

Does the target table has autoincrement columns.

Returns:

True if the table has ai columns

getAutoincRowLocation

RowLocation[] getAutoincRowLocation()

gets the row location

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Description copied from class: WriteCursorConstantAction

Read this object from a stream of stored objects.

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class WriteCursorConstantAction

Parameters:

in - read this.

Throws:

IOException - thrown on error

ClassNotFoundException - thrown on error

See Also:

• Externalizable.readExternal(ObjectInput)

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Description copied from class: WriteCursorConstantAction

Write this object to a stream of stored objects.

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class WriteCursorConstantAction

Parameters:

out - write bytes here.

Throws:

IOException - thrown on error

See Also:

• Externalizable.writeExternal(ObjectOutput)

getTypeFormatId

public int getTypeFormatId()

Get the formatID which corresponds to this class.

Returns:

the formatID of this class

getSchemaName

public String getSchemaName()

getTableName

public String getTableName()

getColumnName

public String getColumnName(int i)

gets the name of the desired column in the taget table.

Parameters:

i - the column number

getColumnNames

String[] getColumnNames()

get the array of column names in the target table.

getAutoincIncrement

public long getAutoincIncrement(int i)

gets the increment value for a column.

Parameters:

i - the column number