com.goldencode.p2j.persist

Class FastCopyHelper

java.lang.Object

com.goldencode.p2j.persist.FastCopyHelper

public class FastCopyHelper
extends java.lang.Object

This helper is used when we need to copy records from one temp-table to another in bulk mode. Using statements like "insert into select from" significantly improves the time performance. However this technique can be used only when the source and destination tables are compatible. Also, this helper operates directly with the persistence layer (without using intermediate buffer validations and such). This means that we need to ensure at SQL level that the records are copied correctly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	FastCopyHelper.FastCopyBundle Class that stores a bundle of SQL that will need to be executed in order to perform the copy process.
(package private) class	FastCopyHelper.FastCopyBundleElement Class that denotes an element of the bundle.
(package private) static class	FastCopyHelper.FastCopyContext Builder/Context for a FastCopyHelper.
(package private) static class	FastCopyHelper.FastCopyKey Class that acts as the key for the fastCopyCache.

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	ALLOW_UID Flag used to enable usage of uid for intermediate tables
private boolean	appendMode Flag that indicates whether copying should be executed in APPEND mode or not.
private static java.lang.String	BEFORE_PK_MAPPING The name of the db level mapping used intermediary by the copy process for before tables
private java.lang.Boolean	canFastCopy Variable that stores the result of the canUseFastCopy function.
private static java.lang.String	DST__PK Name of the field in a database-level pk mapping, which stores a destination pk
private java.lang.Class<? extends DataModelObject>	dstDmoInterface The DMO interface of the destination.
private DmoMeta	dstMeta The meta information of the destination.
private java.util.List<Property>	dstSimpleProps The list of properties specific to the destination temp-table.
private java.lang.String	dstTableName The destination table name.
private java.util.Map<java.lang.Integer,java.util.List<Property[]>>	extentFields A collection of extent fields.
private FastCopyHelper.FastCopyBundle	fastCopyBundle The bundle of SQLs that will be executed to perform the copy process.
private boolean	forceMapping true if this fast-copy helper will force the creation of an intermediate PK mapping
private boolean	generatesPkMapping Flag set when a database level mapping exists for the copy operation.
private boolean	isBefore Flag which indicates if the targets are before tables.
private static java.lang.String	LIST__INDEX__TABLE Name of a generic use intermediate table, used for storing the indexes of an extent
private boolean	looseCopyMode Flag that indicates if this is a loose copy process.
private static java.lang.String	MASTER_PK_MAPPING The name of the db level mapping used intermediary by the copy process for master tables
private static java.lang.String	MULTIPLEX_FIELD_NAME Name of the multiplex ID field in temp table DMO classes
private java.lang.String	pkMappingName Name of a generic use temporary table, used for intermediary operations.
private java.util.Map<RecordBuffer.DatumAccess,RecordBuffer.DatumAccess>	propsMap A property mapping in case this is not a simple copy.
private boolean	simpleCopy Flag which indicates that this is a simpleCopy (no need for property mapping)
private java.lang.String	sort A cache for the sort clause used when copying tables.
private static java.lang.String	SRC__PK Name of the field in a database-level pk mapping, which stores a source pk
private Dialect	srcDialect The dialect of the source.
private java.lang.Class<? extends DataModelObject>	srcDmoInterface The DMO interface of the source.
private java.lang.String	srcImplicitIndexName The source index name.
private java.lang.String	srcImplicitSqlIndexName The source index name used in SQLs.
private DmoMeta	srcMeta The meta information of the source.
private Persistence	srcPersistence The persistence of the source.
private java.util.List<Property>	srcSimpleProps The list of properties specific to the source temp-table.
private java.lang.String	srcTableName The source table name.
private long	uid A value used to generate unique names for the tables used for intermediate operations and storing.
private static java.util.concurrent.atomic.AtomicLong	uidCounter A value used to increment the uid upon instantiation of FastCopyHelper.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	FastCopyHelper(FastCopyHelper.FastCopyContext fastCopyContext) Constructor that is based on the context given.

Method Summary

Modifier and Type	Method and Description
private void	appendColumnName(DmoMeta srcMeta, DmoMeta dstMeta, Property srcProp, Property dstProp, java.lang.StringBuilder srcSb, java.lang.StringBuilder dstSb, java.util.List<java.lang.Object> args) A helper method which will append a source and destination property name to correct string builders: comma separated and having support for datetime-tz data type.
private java.lang.String	assembleUidMapping(java.lang.String property) Append the uid value to properties in order to generate unique names for the temporary and intermediary tables used in operations or storing indexes,
(package private) boolean	canUseFastCopy() This should be used to determine if this helper can be used in order to execute a fast copy on the provided temp-tables.
(package private) void	clear(FastCopyHelper.FastCopyContext ctx) Particular method which clears the intermediate database-level pk mapping for the table copy.
private java.util.List<java.lang.String>	computeUniqueConstraintsClauses(java.util.List<Property> srcSimpleProps, java.util.List<Property> dstSimpleProps) Identify a list of where clauses which rule out duplicate records when copying from a source to a destination.
private void	copyExtentFields(FastCopyHelper.FastCopyContext fastCopyContext) This method will call for copyExtentFields(java.util.Map<java.lang.Integer, java.util.List<com.goldencode.p2j.persist.orm.Property[]>>, java.lang.String, long) with table specific parameters.
private void	copyExtentFields(java.util.Map<java.lang.Integer,java.util.List<Property[]>> extentFields, java.lang.String pkMappingTableName, long uid) The procedure which handles the copy between extent tables (only when source and destination properties are both normalized).
private void	copyTable(FastCopyHelper.FastCopyContext fastCopyContext, boolean loose) This method will call for copyTable(com.goldencode.p2j.persist.FastCopyHelper.FastCopyContext, java.util.List<com.goldencode.p2j.persist.orm.Property>, java.util.List<com.goldencode.p2j.persist.orm.Property>, java.lang.String, boolean) with table specific parameters.
private FastCopyHelper.FastCopyBundleElement	copyTable(FastCopyHelper.FastCopyContext fastCopyContext, java.util.List<Property> srcSimpleProps, java.util.List<Property> dstSimpleProps, java.lang.String sort, boolean looseCopy) The main procedure involved when copying the records from a source to a destination.
static void	createMappings(Persistence persistence) Create the in-database mappings which are used for intermediary steps in the fast-copy process.
private void	createPkMapping(FastCopyHelper.FastCopyContext fastCopyContext) This method will call for createPkMapping(com.goldencode.p2j.persist.FastCopyHelper.FastCopyContext, java.lang.String, java.lang.String, boolean) with table specific parameters.
private void	createPkMapping(FastCopyHelper.FastCopyContext fastCopyContext, java.lang.String sort, java.lang.String pkMappingTableName, boolean addToBundle) This will create a database-level primary key mapping which can be used in other operations (through join) in order to speed up the copy process.
static void	dropMappings(Session session) Drop the in-database mappings which are used for intermediary steps in the fast-copy process.
(package private) rowid	executeCopy(FastCopyHelper.FastCopyContext fastCopyContext, rowid srcRecId) Performance improved variant, when we know the destination table can have its records inserted via INSERT INTO ...
private rowid	executeCopyImpl(FastCopyHelper.FastCopyContext fastCopyContext, rowid srcRecId) Method used to execute the SQLs for the copy process and, if needed, set the destination rowid.
private java.lang.String	getDstTableSql() Compute the destination table update SQL.
private java.lang.StringBuilder	getDstTempColumns() This builds the columns to which the records should be copied.
private java.lang.String	getExtentInsertSql(java.lang.String srcExtent, java.lang.String dstExtent, java.lang.String extColumnListSrc, java.lang.String extColumnListDst, java.lang.String pkMappingTableName) A generator method which provides a suitable SQL to insert all records from an extent table to another based on an in-database primary key mapping.
private java.lang.String	getFastTableCopySql(java.lang.String srcTable, java.lang.String dstTable, java.lang.String columnListSrc, java.lang.String columnListDst, java.lang.String sqlIndexName, java.lang.String sort) A generator method which will copy the records from a source table into a destination table.
private java.lang.Object	getInitialValue(DmoMeta meta, Property prop) Retrieve the initial value of a certain property.
private java.lang.String	getMappedPropName(java.lang.String propName, java.util.List<Property> from, java.util.List<Property> to) Identify the name of the property in the destination which should match the provided property from the source.
private java.util.Map<java.lang.Long,java.lang.Long[]>	getMapping(FastCopyHelper.FastCopyContext fastCopyContext) This method will call for getMapping(com.goldencode.p2j.persist.Persistence, java.lang.String) with table specific parameters.
private java.util.Map<java.lang.Long,java.lang.Long[]>	getMapping(Persistence persistence, java.lang.String pkMappingTableName) This will retrieve the database-level pk mapping into a local mapping.
private java.lang.String	getPkMappingSql(java.lang.String srcTable, java.lang.String dstTable, java.lang.String sqlIndexName, java.util.List<java.lang.String> extraWhereClauses, java.lang.String sort, java.lang.String pkMappingTableName) A generator method which will create a database-level primary key mapping which can be used (through join) in order to speed up the copy process.
private java.lang.String	getSafeTableCopySqlNoMapping(java.lang.String srcTable, java.lang.String dstTable, java.lang.String columnListSrc, java.lang.String columnListDst, java.lang.String sqlIndexName, java.util.List<java.lang.String> extraWhereClauses, java.lang.String sort) A generator method which will copy the records from a source table into a destination table with an additional condition on the recid of the source table.
private java.lang.String	getShadowCopySql(java.lang.String srcTable, java.lang.String dstTable, java.lang.String columnListSrc, java.lang.String columnListDst, java.lang.String sort, java.lang.String pkMappingTableName) A generator method which will copy the records from a source table into a destination table based on an already existing database-level pk mapping.
private java.lang.String	getSimpleExtentInsertSql(int extent, java.lang.String dstExtent, java.lang.String extColumnListSrc, java.lang.String extColumnListDst, java.lang.String pkMappingTableName, long uid) Special generator method which provides a suitable SQL to insert into a destination table only default values.
private java.lang.String	getSortClause() This method will call for getSortClause(java.lang.String) with table specific parameters.
private java.lang.String	getSortClause(java.lang.String indexName) This will return the sort clause which should be used (in case am explicit index name is provided).
private java.lang.StringBuilder	getSrcMappedColumns(java.lang.String pkMappingTableName) A particular method which builds the columns from which the records should be copied in a context where an intermediate database-level pk mapping is used.
private java.lang.StringBuilder	getSrcMappedWildcard(java.lang.String pkMappingTableName, java.lang.String sourceTableName) A particular method which builds a wildcard from which the records should be copied in a context where an intermediate database-level pk mapping is used.
private java.lang.StringBuilder	getSrcTempColumns(java.lang.String dstTableName) This builds the columns from which the records should be copied.
private java.lang.StringBuilder	getSrcTempWildcard(java.lang.String dstTableName, java.lang.String sourcetableName) This builds a wildcard for the given table instead of the columns.
private void	initialize(TemporaryBuffer srcBuf, TemporaryBuffer dstBuf) Given the buffers used, initialize the fields that will be required in this class.
private boolean	processProperties() This extracts information from the source and destination tables.
private FastCopyHelper.FastCopyBundleElement	safeTableCopy(FastCopyHelper.FastCopyContext fastCopyContext, java.util.List<Property> srcSimpleProps, java.util.List<Property> dstSimpleProps, java.lang.String sort, java.lang.String pkMappingTableName, boolean looseCopy) A more complex way to copy a temp-table which ensures that the unique constraints won't be violated after copy.
private FastCopyHelper.FastCopyBundleElement	safeTableCopyNoMapping(FastCopyHelper.FastCopyContext fastCopyContext, java.util.List<Property> srcSimpleProps, java.util.List<Property> dstSimpleProps, java.lang.String sort, boolean looseCopy) Handles the copy of the records from a source to a destination without using intermediate tables.
(package private) static void	updatePeerRecords(FastCopyHelper masterCopyHelper, FastCopyHelper.FastCopyContext masterCopyContext, FastCopyHelper beforeCopyHelper, FastCopyHelper.FastCopyContext beforeCopyContext) This method will update the peer values in the master and before tables.

Methods inherited from class java.lang.Object

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

Field Detail

MULTIPLEX_FIELD_NAME

private static final java.lang.String MULTIPLEX_FIELD_NAME

Name of the multiplex ID field in temp table DMO classes

See Also:

Constant Field Values

LIST__INDEX__TABLE

private static final java.lang.String LIST__INDEX__TABLE

Name of a generic use intermediate table, used for storing the indexes of an extent

See Also:

Constant Field Values

DST__PK

private static final java.lang.String DST__PK

Name of the field in a database-level pk mapping, which stores a destination pk

See Also:

Constant Field Values

SRC__PK

private static final java.lang.String SRC__PK

Name of the field in a database-level pk mapping, which stores a source pk

See Also:

Constant Field Values

MASTER_PK_MAPPING

private static final java.lang.String MASTER_PK_MAPPING

The name of the db level mapping used intermediary by the copy process for master tables

See Also:

Constant Field Values

BEFORE_PK_MAPPING

private static final java.lang.String BEFORE_PK_MAPPING

The name of the db level mapping used intermediary by the copy process for before tables

See Also:

Constant Field Values

ALLOW_UID

private static final boolean ALLOW_UID

Flag used to enable usage of uid for intermediate tables

See Also:

Constant Field Values

uidCounter

private static java.util.concurrent.atomic.AtomicLong uidCounter

A value used to increment the uid upon instantiation of FastCopyHelper.

fastCopyBundle

private final FastCopyHelper.FastCopyBundle fastCopyBundle

The bundle of SQLs that will be executed to perform the copy process.

isBefore

private final boolean isBefore

Flag which indicates if the targets are before tables.

simpleCopy

private final boolean simpleCopy

Flag which indicates that this is a simpleCopy (no need for property mapping)

appendMode

private final boolean appendMode

Flag that indicates whether copying should be executed in APPEND mode or not.

looseCopyMode

private final boolean looseCopyMode

Flag that indicates if this is a loose copy process.

canFastCopy

private java.lang.Boolean canFastCopy

Variable that stores the result of the canUseFastCopy function.

pkMappingName

private final java.lang.String pkMappingName

Name of a generic use temporary table, used for intermediary operations.

generatesPkMapping

private boolean generatesPkMapping

Flag set when a database level mapping exists for the copy operation.

srcPersistence

private Persistence srcPersistence

The persistence of the source.

srcMeta

private DmoMeta srcMeta

The meta information of the source.

dstMeta

private DmoMeta dstMeta

The meta information of the destination.

srcDmoInterface

private java.lang.Class<? extends DataModelObject> srcDmoInterface

The DMO interface of the source.

dstDmoInterface

private java.lang.Class<? extends DataModelObject> dstDmoInterface

The DMO interface of the destination.

srcDialect

private Dialect srcDialect

The dialect of the source.

srcTableName

private java.lang.String srcTableName

The source table name.

dstTableName

private java.lang.String dstTableName

The destination table name.

srcImplicitIndexName

private java.lang.String srcImplicitIndexName

The source index name.

srcImplicitSqlIndexName

private java.lang.String srcImplicitSqlIndexName

The source index name used in SQLs.

propsMap

private java.util.Map<RecordBuffer.DatumAccess,RecordBuffer.DatumAccess> propsMap

A property mapping in case this is not a simple copy.

srcSimpleProps

private java.util.List<Property> srcSimpleProps

The list of properties specific to the source temp-table.

dstSimpleProps

private java.util.List<Property> dstSimpleProps

The list of properties specific to the destination temp-table.

extentFields

private java.util.Map<java.lang.Integer,java.util.List<Property[]>> extentFields

A collection of extent fields. The key is the extent. The value is a list of two properties (the source property and destination property).

sort

private java.lang.String sort

A cache for the sort clause used when copying tables.

uid

private long uid

A value used to generate unique names for the tables used for intermediate operations and storing.

forceMapping

private boolean forceMapping

true if this fast-copy helper will force the creation of an intermediate PK mapping

Constructor Detail

FastCopyHelper

private FastCopyHelper(FastCopyHelper.FastCopyContext fastCopyContext)

Constructor that is based on the context given.

Parameters:

fastCopyContext - The context that has the information required.

Method Detail

createMappings

public static void createMappings(Persistence persistence)

Create the in-database mappings which are used for intermediary steps in the fast-copy process. Complex copy attempts implying extent tables and before tables, require a PK mapping to join with. This PK mapping is stored in these intermediary tables. Creating only one pair of tables per session (one for master and one for before) is an optimization. Creating and dropping at each fast-copy bundle will force the reparsing of the statements using the PK mapping tables.

Parameters:

persistence - The persistence in which the tables should be created.

dropMappings

public static void dropMappings(Session session)
                         throws PersistenceException

Drop the in-database mappings which are used for intermediary steps in the fast-copy process. Use the session instead of the persistence as this is usually called in a clean-up routine where we don't have access to the context anymore

Parameters:

session - The persistence from which the tables should be dropped.

Throws:

PersistenceException - This is thrown if the persistence layer fails

updatePeerRecords

static void updatePeerRecords(FastCopyHelper masterCopyHelper,
                              FastCopyHelper.FastCopyContext masterCopyContext,
                              FastCopyHelper beforeCopyHelper,
                              FastCopyHelper.FastCopyContext beforeCopyContext)
                       throws PersistenceException

This method will update the peer values in the master and before tables. This is mandatory as long as before tables exist. Otherwise, inconsistencies may appear.

Parameters:

masterCopyHelper - The master instance that handled the master copy.

masterCopyContext - The master context that handled the master copy.

beforeCopyHelper - The before instance that handled the before copy.

beforeCopyContext - The before context that handled the before copy.

Throws:

PersistenceException

executeCopy

rowid executeCopy(FastCopyHelper.FastCopyContext fastCopyContext,
                  rowid srcRecId)
           throws PersistenceException

Performance improved variant, when we know the destination table can have its records inserted via INSERT INTO ... SELECT FROM, without having to do any validation on the records, as the destination table will accept them all. If the copy bundle is already computed, then this method will simply determine the execution of the SQLs. Otherwise, It will generate them and then it will execute.

Parameters:

fastCopyContext - The context that has the required information.

srcRecId - A source record id for which a destination record id should be computed at the end. If this is null, then null will be returned.

Returns:

The recid in the destination equivalent to the provided source recid if not null.

Throws:

PersistenceException

canUseFastCopy

boolean canUseFastCopy()

This should be used to determine if this helper can be used in order to execute a fast copy on the provided temp-tables.

Returns:

true if this helper can be used for fast-copy.

clear

void clear(FastCopyHelper.FastCopyContext ctx)
    throws PersistenceException

Particular method which clears the intermediate database-level pk mapping for the table copy. This will eventually drop any such table.

Parameters:

ctx - The fast-copy context in which this pk mapping clear is done.

Throws:

PersistenceException

initialize

private void initialize(TemporaryBuffer srcBuf,
                        TemporaryBuffer dstBuf)

Given the buffers used, initialize the fields that will be required in this class.

Parameters:

srcBuf - The source buffer.

dstBuf - The destination buffer.

executeCopyImpl

private rowid executeCopyImpl(FastCopyHelper.FastCopyContext fastCopyContext,
                              rowid srcRecId)
                       throws PersistenceException

Method used to execute the SQLs for the copy process and, if needed, set the destination rowid.

Parameters:

fastCopyContext - The context with the required information.

srcRecId - The rowid of the current record in the source buffer - if not null, it will be set in the destination buffer, too.

Returns:

The destination rowid.

Throws:

PersistenceException

copyTable

private FastCopyHelper.FastCopyBundleElement copyTable(FastCopyHelper.FastCopyContext fastCopyContext,
                                                       java.util.List<Property> srcSimpleProps,
                                                       java.util.List<Property> dstSimpleProps,
                                                       java.lang.String sort,
                                                       boolean looseCopy)

The main procedure involved when copying the records from a source to a destination. This processes the tables and executes a fast table copy SQL meant to insert into the destination a record selection from the source. The properties given as parameters are already ordered such that the insert SQL will automatically match the correct fields.

Parameters:

fastCopyContext - The context that has the required information.

srcSimpleProps - A list of properties in the source table.

dstSimpleProps - A list of properties in the destination table.

sort - The sort clause which should be used when computing the insert SQL.

looseCopy - If the copy is in loose mode.

Returns:

The bundle element whose execution will do the copy.

safeTableCopy

private FastCopyHelper.FastCopyBundleElement safeTableCopy(FastCopyHelper.FastCopyContext fastCopyContext,
                                                           java.util.List<Property> srcSimpleProps,
                                                           java.util.List<Property> dstSimpleProps,
                                                           java.lang.String sort,
                                                           java.lang.String pkMappingTableName,
                                                           boolean looseCopy)

A more complex way to copy a temp-table which ensures that the unique constraints won't be violated after copy. This only checks that the new records are not already in the destination (according to any unique constraint). It does not check for duplicates in the source; this should be ruled out by the compatibility checker canUseFastCopy(). This technique uses a pre-copy pk mapping, which means that at first we will have a preselection of the records from the source. Afterwards, we apply a "shadow" copy, meaning that we won't check the constraints anymore; we just copy the preselected records from the source to the destination. This will create a pk mapping. This won't allow post-copy pk mappings as they won't be safe.

Parameters:

fastCopyContext - The context that has the required information.

srcSimpleProps - A list of properties in the source table.

dstSimpleProps - A list of properties in the destination table.

sort - The sort clause which should be used when computing the insert SQL.

pkMappingTableName - The name of the intermediate table which will be used for pk mapping.

looseCopy - If the copy is in loose mode.

Returns:

The bundle element whose execution will do the copy.

safeTableCopyNoMapping

private FastCopyHelper.FastCopyBundleElement safeTableCopyNoMapping(FastCopyHelper.FastCopyContext fastCopyContext,
                                                                    java.util.List<Property> srcSimpleProps,
                                                                    java.util.List<Property> dstSimpleProps,
                                                                    java.lang.String sort,
                                                                    boolean looseCopy)

Handles the copy of the records from a source to a destination without using intermediate tables. This type of copy is done only in append mode when there is no need for mapping afterwards for extents/before table/destRecId. The mapping is replaced by "inlining" it into the where clause and using an additional condition for the recid to avoid an infinite loop.

Parameters:

fastCopyContext - The context that has the required information.

srcSimpleProps - A list of properties in the source table.

dstSimpleProps - A list of properties in the destination table.

sort - The sort clause which should be used when computing the insert SQL.

looseCopy - If the copy is in loose mode.

Returns:

The bundle element whose execution will do the copy.

computeUniqueConstraintsClauses

private java.util.List<java.lang.String> computeUniqueConstraintsClauses(java.util.List<Property> srcSimpleProps,
                                                                         java.util.List<Property> dstSimpleProps)

Identify a list of where clauses which rule out duplicate records when copying from a source to a destination. A duplicate record is one which will violate destination's unique constraints. There are multiple such clauses, one for each unique constraint. Each clause will check the multiplex value and the properties which take part in the constraint.

Parameters:

srcSimpleProps - A list of properties in the source table.

dstSimpleProps - A list of properties in the destination table.

Returns:

A list of SQL where clauses which can preselect records from the source which won't violate the unique constraints from the destination.

getMappedPropName

private java.lang.String getMappedPropName(java.lang.String propName,
                                           java.util.List<Property> from,
                                           java.util.List<Property> to)

Identify the name of the property in the destination which should match the provided property from the source. They should be on the same position in the list of properties. Note that the result may be the same as the input (in case of a simple copy; the DMO implementation of the source is the same for destination), but generally they can be different.

Parameters:

propName - The property name for which we search a correspondent.

from - The list of properties for the DMO containing the provided property name.

to - The list of properties in which we search for a correspondent.

Returns:

The name of the correspondent property or null if not found.

copyExtentFields

private void copyExtentFields(java.util.Map<java.lang.Integer,java.util.List<Property[]>> extentFields,
                              java.lang.String pkMappingTableName,
                              long uid)

The procedure which handles the copy between extent tables (only when source and destination properties are both normalized). For this part to work fast (so use the "insert into select from" paradigm), we will need a primary key mapping. Unless one is already created, this method will create a database level pkMapping (which can be used further in other scenarios).

Parameters:

extentFields - The mapping between the source extent fields and destination extent fields. This mapping is done per extent value.

pkMappingTableName - The name of the table which will be used as a database level primary key mapping.

uid - Value used to generate unique names for intermediate tables.

createPkMapping

private void createPkMapping(FastCopyHelper.FastCopyContext fastCopyContext,
                             java.lang.String sort,
                             java.lang.String pkMappingTableName,
                             boolean addToBundle)
                      throws PersistenceException

This will create a database-level primary key mapping which can be used in other operations (through join) in order to speed up the copy process.

Parameters:

fastCopyContext - The context that has the required information.

sort - The sort clause used when the records were copied between main tables.

pkMappingTableName - The name which should be used by the table which will store the primary key mapping. This does not check if the pkMappingTableName already exists.

addToBundle - true if instead of immediately executing the SQLs, they can be added to the bundle and be executed at the end, false otherwise.

Throws:

PersistenceException

getExtentInsertSql

private java.lang.String getExtentInsertSql(java.lang.String srcExtent,
                                            java.lang.String dstExtent,
                                            java.lang.String extColumnListSrc,
                                            java.lang.String extColumnListDst,
                                            java.lang.String pkMappingTableName)

A generator method which provides a suitable SQL to insert all records from an extent table to another based on an in-database primary key mapping. This will work only if the pk mapping was already created.

Parameters:

srcExtent - The name of the source extent temp-table.

dstExtent - The name of the destination extent temp-table.

extColumnListSrc - A string containing the columns from which the copy should be done.

extColumnListDst - A string containing the columns to which the copy should be done.

pkMappingTableName - The name of the table which stores the primary key mapping.

Returns:

The SQL which copies the records from one source extent table to a destination one.

getSimpleExtentInsertSql

private java.lang.String getSimpleExtentInsertSql(int extent,
                                                  java.lang.String dstExtent,
                                                  java.lang.String extColumnListSrc,
                                                  java.lang.String extColumnListDst,
                                                  java.lang.String pkMappingTableName,
                                                  long uid)

Special generator method which provides a suitable SQL to insert into a destination table only default values. This is based on an in-databse primary key mapping in order to correctly set the parent id. The list index will be locally generated and the values are set to default. This should be used when a source table exists, but an separate extent table for the source doesn't.

Parameters:

extent - The size of the extent for which the insert sql should be generated.

dstExtent - The name of the destination extent table.

extColumnListSrc - A list of fields from which the copy should be done. This should be formed only by ?, which will be set on the default values.

extColumnListDst - A list of the names of the extent field properties in the destination.

pkMappingTableName - The name of the in database pk mapping from which the parent-id will be extracted.

uid - Value used to generate unique names for intermediate tables.

Returns:

The SQL which creates new default records in the destination table.

getPkMappingSql

private java.lang.String getPkMappingSql(java.lang.String srcTable,
                                         java.lang.String dstTable,
                                         java.lang.String sqlIndexName,
                                         java.util.List<java.lang.String> extraWhereClauses,
                                         java.lang.String sort,
                                         java.lang.String pkMappingTableName)

A generator method which will create a database-level primary key mapping which can be used (through join) in order to speed up the copy process.

Parameters:

srcTable - The name of the source table.

dstTable - The name of the destination table.

sqlIndexName - The SQL name of the index used in the main table copy process

extraWhereClauses - A list of extra where clauses that need to be appended.

sort - The sort clause used in the main table copy process.

pkMappingTableName - The name which should be used for the generated table.

Returns:

The SQL which creates a database level primary key mapping.

getShadowCopySql

private java.lang.String getShadowCopySql(java.lang.String srcTable,
                                          java.lang.String dstTable,
                                          java.lang.String columnListSrc,
                                          java.lang.String columnListDst,
                                          java.lang.String sort,
                                          java.lang.String pkMappingTableName)

A generator method which will copy the records from a source table into a destination table based on an already existing database-level pk mapping.

Parameters:

srcTable - The name of the source table.

dstTable - the name of the destination table.

columnListSrc - A string containing the columns from which the copy should be done.

columnListDst - A string containing the columns to which the copy should be done.

sort - The sort clause

pkMappingTableName - The table which contains the pk mapping.

Returns:

The SQL which copies records from the source to the destination based on the provided pk mapping.

getFastTableCopySql

private java.lang.String getFastTableCopySql(java.lang.String srcTable,
                                             java.lang.String dstTable,
                                             java.lang.String columnListSrc,
                                             java.lang.String columnListDst,
                                             java.lang.String sqlIndexName,
                                             java.lang.String sort)

A generator method which will copy the records from a source table into a destination table.

Parameters:

srcTable - The name of the source table.

dstTable - the name of the destination table.

columnListSrc - A string containing the columns from which the copy should be done.

columnListDst - A string containing the columns to which the copy should be done.

sqlIndexName - The name of the index which should be used when copying records.

sort - The sort clause.

Returns:

The SQL which copies records from the source to the destination

getSafeTableCopySqlNoMapping

private java.lang.String getSafeTableCopySqlNoMapping(java.lang.String srcTable,
                                                      java.lang.String dstTable,
                                                      java.lang.String columnListSrc,
                                                      java.lang.String columnListDst,
                                                      java.lang.String sqlIndexName,
                                                      java.util.List<java.lang.String> extraWhereClauses,
                                                      java.lang.String sort)

A generator method which will copy the records from a source table into a destination table with an additional condition on the recid of the source table.

Parameters:

srcTable - The name of the source table.

dstTable - the name of the destination table.

columnListSrc - A string containing the columns from which the copy should be done.

columnListDst - A string containing the columns to which the copy should be done.

sqlIndexName - The name of the index which should be used when copying records.

extraWhereClauses - Other where clauses to be included. Used to implement append-mode.

sort - The sort clause.

Returns:

The SQL which copies records from the source to the destination

getSrcTempColumns

private java.lang.StringBuilder getSrcTempColumns(java.lang.String dstTableName)

This builds the columns from which the records should be copied. Note that the first columns are given through parameters: this should stand for the pk and _multiplex. However, when we will insert into the destination, the pk is assigned automatically by the database, while the _multiplex is fixed.

Parameters:

dstTableName - The name of the destination table. This is used to use the NEXT PK functionality.

Returns:

A string builder containing the columns which should be copied in the right order. This is a string builder as it is expected that this column list will be completed with other names.

getSrcTempWildcard

private java.lang.StringBuilder getSrcTempWildcard(java.lang.String dstTableName,
                                                   java.lang.String sourcetableName)

This builds a wildcard for the given table instead of the columns. The first columns are given through parameters: this should stand for the pk (recid) and _multiplex. When inserting into the destination, the pk is assigned automatically by the database and the multiplex is a prepared value. The pk and _multiplex need to be excepted from the wildcard selection, this is done using EXCEPT.

Parameters:

dstTableName - The name of the destination table. This is used to use the NEXT PK functionality.

sourcetableName - The name of the source table.

Returns:

A string builder containing the columns which should be copied in the right order. This is a string builder as it is expected that this column list will be completed with other names.

getSrcMappedColumns

private java.lang.StringBuilder getSrcMappedColumns(java.lang.String pkMappingTableName)

A particular method which builds the columns from which the records should be copied in a context where an intermediate database-level pk mapping is used. For this case, the destination pk won't be generated automatically by the table using NEXT PK, but extracted from the provided pk mapping.

Parameters:

pkMappingTableName - The database-level pk mapping which is used when doing the copy.

Returns:

A string builder containing the columns which should be copied in the right order. This is a string builder as it is expected that this column list will be completed with other names.

getSrcMappedWildcard

private java.lang.StringBuilder getSrcMappedWildcard(java.lang.String pkMappingTableName,
                                                     java.lang.String sourceTableName)

A particular method which builds a wildcard from which the records should be copied in a context where an intermediate database-level pk mapping is used. For this case, the destination pk won't be generated automatically by the table using NEXT PK, but extracted from the provided pk mapping. Note that pk and _multiplex need to be excepted from the wildcard selection of the source table, this is done using EXCEPT.

Parameters:

pkMappingTableName - The database-level pk mapping which is used when doing the copy.

sourceTableName - The name of the source table.

Returns:

A string builder containing a wildcard for the source table which should be copied in the right order.

getDstTempColumns

private java.lang.StringBuilder getDstTempColumns()

This builds the columns to which the records should be copied. Note that all columns are fixed.

Returns:

A string builder containing the target columns in the right order. This is a string builder as it is expected that this column list will be completed with other names.

processProperties

private boolean processProperties()

This extracts information from the source and destination tables. The most important part is the ordering of the properties - which can be done through a specified property mapping. Also, this will identify the extent fields (and the mapping of them between the source and destination).

Returns:

true if the processing didn't required loose-mode, so that the order of the properties in the source matches the one in the destination.

appendColumnName

private void appendColumnName(DmoMeta srcMeta,
                              DmoMeta dstMeta,
                              Property srcProp,
                              Property dstProp,
                              java.lang.StringBuilder srcSb,
                              java.lang.StringBuilder dstSb,
                              java.util.List<java.lang.Object> args)

A helper method which will append a source and destination property name to correct string builders: comma separated and having support for datetime-tz data type. Note that this should not be used for the first column (as it will have a leading comma). This also handles the cases when the source property is null, so a default value should be added to the source fields.

Parameters:

srcMeta - The dmo meta of the source.

dstMeta - The dmo meta of the destination. Used to retrieve eventual initial values.

srcProp - The source property which should be appended to the list of source fields.

dstProp - The destination property which should be appended to the list of source fields.

srcSb - The string builder which shall hold the information about the source fields.

dstSb - The string builder which shall hold the information about the destination fields.

args - The list of parameters which will be used in the SQL. Here the default will be appended if needed.

getSortClause

private java.lang.String getSortClause(java.lang.String indexName)
                                throws PersistenceException

This will return the sort clause which should be used (in case am explicit index name is provided). If no index name is provided, the sort clause will be a simple combination between the multiplex and pk fields.

Parameters:

indexName - The index which should be taken in consideration when computing the sort clause. This can be null, resulting in a default sort clause.

Returns:

A sort clause suitable for the provided buffer and index name.

Throws:

PersistenceException

getMapping

private java.util.Map<java.lang.Long,java.lang.Long[]> getMapping(Persistence persistence,
                                                                  java.lang.String pkMappingTableName)
                                                           throws PersistenceException

This will retrieve the database-level pk mapping into a local mapping. This should be used only when the database-level pk mapping can't be used in the desired scenario.

Parameters:

persistence - A persistence instance which should be used in order to retrieve the database-level pk mapping.

pkMappingTableName - The name of the table which stored the database-level pk mapping.

Returns:

A map between the source pk and a group formed by the destination pk and source peer id

Throws:

PersistenceException

getInitialValue

private java.lang.Object getInitialValue(DmoMeta meta,
                                         Property prop)

Retrieve the initial value of a certain property. The meta is used in order to retrieve the property metas which can be checked against the provided property and find the initial value.

Parameters:

meta - The meta of the dmo for the provided property.

prop - The property for which the initial value should be retrieved.

Returns:

The initial value of the provided property.

copyTable

private void copyTable(FastCopyHelper.FastCopyContext fastCopyContext,
                       boolean loose)
                throws PersistenceException

This method will call for copyTable(com.goldencode.p2j.persist.FastCopyHelper.FastCopyContext, java.util.List<com.goldencode.p2j.persist.orm.Property>, java.util.List<com.goldencode.p2j.persist.orm.Property>, java.lang.String, boolean) with table specific parameters. Also this will trigger processProperties() which will analyze the tables and compute a list of their properties (and extents) in a copy suitable order.

Parameters:

fastCopyContext - The context that has the information required.

loose - If the copy is in loose mode.

Throws:

PersistenceException

getSortClause

private java.lang.String getSortClause()
                                throws PersistenceException

This method will call for getSortClause(java.lang.String) with table specific parameters. This will also cache the sort clause.

Returns:

The sort clause which should be used in the table copy.

Throws:

PersistenceException

getDstTableSql

private java.lang.String getDstTableSql()

Compute the destination table update SQL.

Returns:

String The dstTableSql field.

copyExtentFields

private void copyExtentFields(FastCopyHelper.FastCopyContext fastCopyContext)
                       throws PersistenceException

This method will call for copyExtentFields(java.util.Map<java.lang.Integer, java.util.List<com.goldencode.p2j.persist.orm.Property[]>>, java.lang.String, long) with table specific parameters. This will also try to create a database-level primary key mapping if it doesn't already exist.

Parameters:

fastCopyContext - The context that has the required information.

Throws:

PersistenceException

createPkMapping

private void createPkMapping(FastCopyHelper.FastCopyContext fastCopyContext)
                      throws PersistenceException

This method will call for createPkMapping(com.goldencode.p2j.persist.FastCopyHelper.FastCopyContext, java.lang.String, java.lang.String, boolean) with table specific parameters. This will take care that a single pk mapping will be online at once.

Parameters:

fastCopyContext - The context that has the required information.

Throws:

PersistenceException

getMapping

private java.util.Map<java.lang.Long,java.lang.Long[]> getMapping(FastCopyHelper.FastCopyContext fastCopyContext)
                                                           throws PersistenceException

This method will call for getMapping(com.goldencode.p2j.persist.Persistence, java.lang.String) with table specific parameters. This will cache eventually the mapping. Also, this may trigger a database-level pk mapping if it doesn't already exist.

Parameters:

fastCopyContext - The context that has the required information.

Returns:

Initializes the cache for the primary key after the copying of tables or returns the cache if it was already created.

Throws:

PersistenceException

assembleUidMapping

private java.lang.String assembleUidMapping(java.lang.String property)

Append the uid value to properties in order to generate unique names for the temporary and intermediary tables used in operations or storing indexes,

Parameters:

property - The property to which uid will be attached.

Returns:

A string representing a unique name.