Package ca.uhn.fhir.jpa.migrate.tasks.api

Class Builder.BuilderCompleteTask

java.lang.Object

ca.uhn.fhir.jpa.migrate.tasks.api.Builder.BuilderCompleteTask

Enclosing class:

Builder

public static class Builder.BuilderCompleteTask
extends Object

Constructor Summary

Constructors

Constructor	Description
BuilderCompleteTask(BaseTask theTask)

Method Summary

Modifier and Type	Method	Description
Builder.BuilderCompleteTask	doNothing()
Builder.BuilderCompleteTask	failureAllowed()
Builder.BuilderCompleteTask	heavyweightSkipByDefault()
Builder.BuilderCompleteTask	onlyAppliesToPlatforms(DriverTypeEnum... theTypes)
Builder.BuilderCompleteTask	onlyIf(String theSql, String reason)	Introduce precondition checking logic into the execution of the enclosed task.
Builder.BuilderCompleteTask	runEvenDuringSchemaInitialization()
Builder.BuilderCompleteTask	setTransactional(boolean theFlag)
Builder.BuilderCompleteTask	withFlag(TaskFlagEnum theFlag)

Methods inherited from class java.lang.Object

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

Constructor Details

BuilderCompleteTask

public BuilderCompleteTask(BaseTask theTask)

Method Details

failureAllowed

public Builder.BuilderCompleteTask failureAllowed()

doNothing

public Builder.BuilderCompleteTask doNothing()

onlyAppliesToPlatforms

public Builder.BuilderCompleteTask onlyAppliesToPlatforms(DriverTypeEnum... theTypes)

onlyIf

public Builder.BuilderCompleteTask onlyIf(@Language("SQL")
 String theSql,
 String reason)

Introduce precondition checking logic into the execution of the enclosed task. This conditional logic will be implemented by running an SQL SELECT (including CTEs) to obtain a boolean indicating whether a certain condition has been met. One example is to check for a specific collation on a column to decide whether to create a new index.

This method may be called multiple times to add multiple preconditions. The precondition that evaluates to false will stop execution of the task irrespective of any or all other tasks evaluating to true.

Parameters:

theSql - The SELECT or CTE used to determine if the precondition is valid.

reason - A String to indicate the text that is logged if the precondition is not met.

Returns:

The BuilderCompleteTask in order to chain further method calls on this builder.

runEvenDuringSchemaInitialization

public Builder.BuilderCompleteTask runEvenDuringSchemaInitialization()

setTransactional

public Builder.BuilderCompleteTask setTransactional(boolean theFlag)

heavyweightSkipByDefault

public Builder.BuilderCompleteTask heavyweightSkipByDefault()

withFlag

public Builder.BuilderCompleteTask withFlag(TaskFlagEnum theFlag)