tasks/ext/liquibase/LiquibaseUpdateTask.php
\LiquibaseUpdateTask
Task to update the database to latest version of the changelog file.
Use {@link Project#createTask} to register a new Task.
- Parent(s)
- \AbstractLiquibaseTask < \Task < \ProjectComponent
- Author
- Stephan Hochdoerfer
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Since
- 2.4.10
- Version
- $Id$
Properties


$changeLogFile= ''
- Type
- n/a
- Inherited_from
- \AbstractLiquibaseTask::$$changeLogFile


$classpathref= ''
- Type
- n/a
- Inherited_from
- \AbstractLiquibaseTask::$$classpathref


string
$description= ''
Description of the task
Inherited from: \Task::$$description\AbstractLiquibaseTask::$$description- Type
- string
- Inherited_from
- \Task::$$description
- Inherited_from
- \AbstractLiquibaseTask::$$description


$jar= ''
- Type
- n/a
- Inherited_from
- \AbstractLiquibaseTask::$$jar


\Location
$location= ''
Stored buildfile location
Inherited from: \Task::$$location\AbstractLiquibaseTask::$$location- Type
- \Location
- Inherited_from
- \Task::$$location
- Inherited_from
- \AbstractLiquibaseTask::$$location


$password= ''
- Type
- n/a
- Inherited_from
- \AbstractLiquibaseTask::$$password


\Project
$project= 'null'
Holds a reference to the project that a project component (a task, a target, etc.) belongs to
A reference to the current project instanceInherited from: \ProjectComponent::$$project\Task::$$project\AbstractLiquibaseTask::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project
- Inherited_from
- \AbstractLiquibaseTask::$$project


\Target
$target= ''
- Type
- \Target
- Inherited_from
- \Task::$$target
- Inherited_from
- \AbstractLiquibaseTask::$$target


string
$taskName= ''
- Type
- string
- Inherited_from
- \Task::$$taskName
- Inherited_from
- \AbstractLiquibaseTask::$$taskName


string
$taskType= ''
- Type
- string
- Inherited_from
- \Task::$$taskType
- Inherited_from
- \AbstractLiquibaseTask::$$taskType


$url= ''
- Type
- n/a
- Inherited_from
- \AbstractLiquibaseTask::$$url


$username= ''
- Type
- n/a
- Inherited_from
- \AbstractLiquibaseTask::$$username


\RuntimeConfigurable
$wrapper= ''
- Type
- \RuntimeConfigurable
- Inherited_from
- \Task::$$wrapper
- Inherited_from
- \AbstractLiquibaseTask::$$wrapper
Methods


checkParams(
)
:
void
Ensure that correct parameters were passed in.
Inherited from: \AbstractLiquibaseTask::checkParams()

execute(
string $lbcommand, string $lbparams
=
''
)
:
string
Executes the given command and returns the output.
Inherited from: \AbstractLiquibaseTask::execute()Name | Type | Description |
---|---|---|
$lbcommand | string | the command to execute |
$lbparams | string | additional parameters |
Type | Description |
---|---|
string | the output of the executed command |


getDescription(
)
:
string
Returns the textual description of the task
Inherited from: \Task::getDescription()\AbstractLiquibaseTask::getDescription()Type | Description |
---|---|
string | The text description of the task |


getLocation(
)
:
\Location
Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.
Inherited from: \Task::getLocation()\AbstractLiquibaseTask::getLocation()Type | Description |
---|---|
\Location | The location object describing the position of this task within the buildfile. |


getOwningTarget(
)
:
\Target
Returns the owning target of this task.
Inherited from: \Task::getOwningTarget()\AbstractLiquibaseTask::getOwningTarget()Type | Description |
---|---|
\Target | The target object that owns this task |


getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\Task::getProject()\AbstractLiquibaseTask::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getRegisterSlot(
string $slotName
)
:
void
Returns a name
Inherited from: \Task::getRegisterSlot()\AbstractLiquibaseTask::getRegisterSlot()Name | Type | Description |
---|---|---|
$slotName | string |


getRuntimeConfigurableWrapper(
)
:
\RuntimeConfigurable
Returns the wrapper object for runtime configuration
Inherited from: \Task::getRuntimeConfigurableWrapper()\AbstractLiquibaseTask::getRuntimeConfigurableWrapper()Type | Description |
---|---|
\RuntimeConfigurable | The wrapper object used by this task |


getTaskName(
)
:
string
Returns the name of task, used only for log messages
Inherited from: \Task::getTaskName()\AbstractLiquibaseTask::getTaskName()Type | Description |
---|---|
string | Name of this task |


getTaskType(
)
:
string
Returns the name of the task under which it was invoked, usually the XML tagname
Inherited from: \Task::getTaskType()\AbstractLiquibaseTask::getTaskType()Type | Description |
---|---|
string | The type of this task (XML Tag) |


init(
)
:
void
Called by the parser to let the task initialize properly.
Inherited from: \Task::init()\AbstractLiquibaseTask::init()Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exception | Description |
---|---|
\BuildException |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Provides a project level log event to the task.
Inherited from: \Task::log()\AbstractLiquibaseTask::log()Name | Type | Description |
---|---|---|
$msg | string | The message to log |
$level | integer | The priority of the message |
- See
- \BuildEvent
- See
- \BuildListener


main(
)
:
void
Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running phing target1 target2 will run all tasks in target3 twice.
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
- See
- \Task::main()


maybeConfigure(
)
:
void
Configure this task if it hasn't been done already.
Inherited from: \Task::maybeConfigure()\AbstractLiquibaseTask::maybeConfigure()

setChangeLogFile(
string $changelogFile
)
:
void
Sets the absolute path to the changelog file to use.
Inherited from: \AbstractLiquibaseTask::setChangeLogFile()Name | Type | Description |
---|---|---|
$changelogFile | string | the absolute path to the changelog file |


setDescription(
string $desc
)
:
void
Sets a textual description of the task
Inherited from: \Task::setDescription()\AbstractLiquibaseTask::setDescription()Name | Type | Description |
---|---|---|
$desc | string | The text describing the task |


setJar(
string $jar
)
:
void
Name | Type | Description |
---|---|---|
$jar | string | the absolute path to the liquibase jar. |


setLocation(
\Location $location
)
:
void
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Inherited from: \Task::setLocation()\AbstractLiquibaseTask::setLocation()Name | Type | Description |
---|---|---|
$location | \Location | The location object describing the position of this task within the buildfile. |


setOwningTarget(
\Target $target
)
:
void
Sets the owning target this task belongs to.
Inherited from: \Task::setOwningTarget()\AbstractLiquibaseTask::setOwningTarget()Name | Type | Description |
---|---|---|
$target | \Target | Reference to owning target |


setPassword(
string $password
)
:
void
Sets the password to connect to the database.
Inherited from: \AbstractLiquibaseTask::setPassword()Name | Type | Description |
---|---|---|
$password | string | the password |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\Task::setProject()\AbstractLiquibaseTask::setProject()Name | Type | Description |
---|---|---|
$project | \Project | The reference to the current project |


setRuntimeConfigurableWrapper(
\RuntimeConfigurable $wrapper
)
:
void
Sets the wrapper object this task should use for runtime configurable elements.
Inherited from: \Task::setRuntimeConfigurableWrapper()\AbstractLiquibaseTask::setRuntimeConfigurableWrapper()Name | Type | Description |
---|---|---|
$wrapper | \RuntimeConfigurable | The wrapper object this task should use |


setTaskName(
string $name
)
:
string
Sets the name of this task for log messages
Inherited from: \Task::setTaskName()\AbstractLiquibaseTask::setTaskName()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string | A string representing the name of this task for log |


setTaskType(
string $name
)
:
void
Sets the type of the task. Usually this is the name of the XML tag
Inherited from: \Task::setTaskType()\AbstractLiquibaseTask::setTaskType()Name | Type | Description |
---|---|---|
$name | string | The type of this task (XML Tag) |


setUrl(
string $url
)
:
void
Sets the url to connect to the database in jdbc style, e.g.
Inherited from: \AbstractLiquibaseTask::setUrl()jdbc:postgresql://psqlhost/mydatabase
Name | Type | Description |
---|---|---|
$url | string | jdbc connection string |


setUsername(
string $username
)
:
void
Sets the username to connect to the database.
Inherited from: \AbstractLiquibaseTask::setUsername()Name | Type | Description |
---|---|---|
$username | string | the username |