com.atlassian.core.ofbiz.actions.index

Class MSSQLIncludedIndexAlternativeAction

java.lang.Object

com.atlassian.core.ofbiz.actions.index.MSSQLIncludedIndexAlternativeAction

All Implemented Interfaces:

org.ofbiz.core.entity.jdbc.alternative.IndexAlternativeAction

Direct Known Subclasses:

EntityPropertyIdNameKeyIndexAlternativeAction, EntityPropertyKeyNameIndexAlternativeAction, PropertyEntryMsSQLIndexAlternativeActionForEntityIdNameProperty

public class MSSQLIncludedIndexAlternativeAction
extends Object
implements org.ofbiz.core.entity.jdbc.alternative.IndexAlternativeAction

Base class for alternative action creating indexes with regard to MS SQL key size constraints. Maximum index key size in MS SQL differs based on its version. This class allows to take an alternative execution path in case the desired key size exceeds the limit. The alternative action bypasses the size restriction by utilizing what's called included (nonkey) columns. Extend it and specify the index details to have it created in such fashion. CONTRACT: extending class must have no-arg constructor CONTRACT: tableName and indexName must match what's defined in entitymodel.xml where the alternative index action is used

Since:

v8.0

See Also:

included columns explanation

Constructor Summary

Constructors

Constructor and Description
MSSQLIncludedIndexAlternativeAction(String tableName, String indexName, List<String> indexedColumnsNames, List<String> includedColumnsNames, int indexSizeToTrigger) CAUTION: column names in MS SQL must be all uppercase with components separated by underscore e.g.

Method Summary

Modifier and Type	Method and Description
String	run(org.ofbiz.core.entity.model.ModelEntity modelEntity, org.ofbiz.core.entity.model.ModelIndex modelIndex, org.ofbiz.core.entity.jdbc.DatabaseUtil dbUtil)
boolean	shouldRun(org.ofbiz.core.entity.model.ModelEntity modelEntity, org.ofbiz.core.entity.model.ModelIndex modelIndex, org.ofbiz.core.entity.jdbc.DatabaseUtil dbUtil)

Methods inherited from class java.lang.Object

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

Constructor Detail

MSSQLIncludedIndexAlternativeAction

public MSSQLIncludedIndexAlternativeAction(String tableName,
                                           String indexName,
                                           List<String> indexedColumnsNames,
                                           List<String> includedColumnsNames,
                                           int indexSizeToTrigger)

CAUTION: column names in MS SQL must be all uppercase with components separated by underscore e.g. PROPERTY_KEY instead of propertyKey.

Parameters:

tableName - of the table this action is to be used with

indexName - of the index this action is to be used with

indexedColumnsNames - names of key columns in case of taking the alternative execution path

includedColumnsNames - names of nonkey columns (included ones) in case of taking the alternative execution path

indexSizeToTrigger - size of the key of the index to be created

Method Detail

shouldRun

public boolean shouldRun(org.ofbiz.core.entity.model.ModelEntity modelEntity,
                         org.ofbiz.core.entity.model.ModelIndex modelIndex,
                         org.ofbiz.core.entity.jdbc.DatabaseUtil dbUtil)
                  throws SQLException,
                         org.ofbiz.core.entity.GenericEntityException

Specified by:

shouldRun in interface org.ofbiz.core.entity.jdbc.alternative.IndexAlternativeAction

Throws:

SQLException

org.ofbiz.core.entity.GenericEntityException

run

public String run(org.ofbiz.core.entity.model.ModelEntity modelEntity,
                  org.ofbiz.core.entity.model.ModelIndex modelIndex,
                  org.ofbiz.core.entity.jdbc.DatabaseUtil dbUtil)
           throws SQLException,
                  org.ofbiz.core.entity.GenericEntityException

Specified by:

run in interface org.ofbiz.core.entity.jdbc.alternative.IndexAlternativeAction

Throws:

SQLException

org.ofbiz.core.entity.GenericEntityException