tasks/ext/liquibase/LiquibaseUpdateTask.php

Show: inherited
Table of Contents

\LiquibaseUpdateTask

Package: phing\tasks\ext\liquibase

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

Propertyprotected  $changeLogFile= ''
inheritedInherited from: \AbstractLiquibaseTask::$$changeLogFile
Details
Type
n/a
Inherited_from
\AbstractLiquibaseTask::$$changeLogFile  
Propertyprotected  $classpathref= ''
inheritedInherited from: \AbstractLiquibaseTask::$$classpathref
Details
Type
n/a
Inherited_from
\AbstractLiquibaseTask::$$classpathref  
Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description\AbstractLiquibaseTask::$$description
Details
Type
string
Inherited_from
\Task::$$description  
Inherited_from
\AbstractLiquibaseTask::$$description  
Propertyprotected  $jar= ''
inheritedInherited from: \AbstractLiquibaseTask::$$jar
Details
Type
n/a
Inherited_from
\AbstractLiquibaseTask::$$jar  
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location\AbstractLiquibaseTask::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
Inherited_from
\AbstractLiquibaseTask::$$location  
Propertyprotected  $password= ''
inheritedInherited from: \AbstractLiquibaseTask::$$password
Details
Type
n/a
Inherited_from
\AbstractLiquibaseTask::$$password  
Propertyprotected\Project  $project= 'null'
inherited

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::$$project
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\Task::$$project  
Inherited_from
\AbstractLiquibaseTask::$$project  
Propertyprotected\Target  $target= ''
inherited

Owning Target object

Inherited from: \Task::$$target\AbstractLiquibaseTask::$$target
Details
Type
\Target
Inherited_from
\Task::$$target  
Inherited_from
\AbstractLiquibaseTask::$$target  
Propertyprotectedstring  $taskName= ''
inherited

Taskname for logger

Inherited from: \Task::$$taskName\AbstractLiquibaseTask::$$taskName
Details
Type
string
Inherited_from
\Task::$$taskName  
Inherited_from
\AbstractLiquibaseTask::$$taskName  
Propertyprotectedstring  $taskType= ''
inherited

Internal taskname (req)

Inherited from: \Task::$$taskType\AbstractLiquibaseTask::$$taskType
Details
Type
string
Inherited_from
\Task::$$taskType  
Inherited_from
\AbstractLiquibaseTask::$$taskType  
Propertyprotected  $url= ''
inheritedInherited from: \AbstractLiquibaseTask::$$url
Details
Type
n/a
Inherited_from
\AbstractLiquibaseTask::$$url  
Propertyprotected  $username= ''
inheritedInherited from: \AbstractLiquibaseTask::$$username
Details
Type
n/a
Inherited_from
\AbstractLiquibaseTask::$$username  
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

Inherited from: \Task::$$wrapper\AbstractLiquibaseTask::$$wrapper
Details
Type
\RuntimeConfigurable
Inherited_from
\Task::$$wrapper  
Inherited_from
\AbstractLiquibaseTask::$$wrapper  

Methods

methodprotectedcheckParams( ) : void
inherited

Ensure that correct parameters were passed in.

Inherited from: \AbstractLiquibaseTask::checkParams()
methodprotectedexecute( string $lbcommand, string $lbparams = '' ) : string
inherited

Executes the given command and returns the output.

Inherited from: \AbstractLiquibaseTask::execute()
Parameters
Name Type Description
$lbcommand string

the command to execute

$lbparams string

additional parameters

Returns
Type Description
string the output of the executed command
methodpublicgetDescription( ) : string
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()\AbstractLiquibaseTask::getDescription()
Returns
Type Description
string The text description of the task
methodpublicgetLocation( ) : \Location
inherited

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

Inherited from: \Task::getLocation()\AbstractLiquibaseTask::getLocation()
Returns
Type Description
\Location The location object describing the position of this task within the buildfile.
methodpublicgetOwningTarget( ) : \Target
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()\AbstractLiquibaseTask::getOwningTarget()
Returns
Type Description
\Target The target object that owns this task
methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()\AbstractLiquibaseTask::getProject()
Returns
Type Description
\Project Reference to current porject object
methodprotectedgetRegisterSlot( string $slotName ) : void
Parameters
Name Type Description
$slotName string
methodpublicgetRuntimeConfigurableWrapper( ) : \RuntimeConfigurable
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()\AbstractLiquibaseTask::getRuntimeConfigurableWrapper()
Returns
Type Description
\RuntimeConfigurable The wrapper object used by this task
methodpublicgetTaskName( ) : string
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()\AbstractLiquibaseTask::getTaskName()
Returns
Type Description
string Name of this task
methodpublicgetTaskType( ) : string
inherited

Returns the name of the task under which it was invoked, usually the XML tagname

Inherited from: \Task::getTaskType()\AbstractLiquibaseTask::getTaskType()
Returns
Type Description
string The type of this task (XML Tag)
methodpublicinit( ) : void
inherited

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.

Throws
Exception Description
\BuildException
methodpubliclog( string $msg, integer $level = Project::MSG_INFO ) : void
inherited

Provides a project level log event to the task.

Inherited from: \Task::log()\AbstractLiquibaseTask::log()
Parameters
Name Type Description
$msg string

The message to log

$level integer

The priority of the message

Details
See
\BuildEvent  
See
\BuildListener  
methodpublicmain( ) : 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.

Details
See
\Task::main()  
methodpublicmaybeConfigure( ) : void
inherited

Configure this task if it hasn't been done already.

Inherited from: \Task::maybeConfigure()\AbstractLiquibaseTask::maybeConfigure()
methodpublicperform( ) : void
inherited

Perfrom this task

Inherited from: \Task::perform()\AbstractLiquibaseTask::perform()
methodpublicsetChangeLogFile( string $changelogFile ) : void
inherited

Sets the absolute path to the changelog file to use.

Inherited from: \AbstractLiquibaseTask::setChangeLogFile()
Parameters
Name Type Description
$changelogFile string

the absolute path to the changelog file

methodpublicsetDescription( string $desc ) : void
inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()\AbstractLiquibaseTask::setDescription()
Parameters
Name Type Description
$desc string

The text describing the task

methodpublicsetJar( string $jar ) : void
inherited

Sets the absolute path to liquibase jar.

Inherited from: \AbstractLiquibaseTask::setJar()
Parameters
Name Type Description
$jar string

the absolute path to the liquibase jar.

methodpublicsetLocation( \Location $location ) : void
inherited

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

Inherited from: \Task::setLocation()\AbstractLiquibaseTask::setLocation()
Parameters
Name Type Description
$location \Location

The location object describing the position of this task within the buildfile.

methodpublicsetOwningTarget( \Target $target ) : void
inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()\AbstractLiquibaseTask::setOwningTarget()
Parameters
Name Type Description
$target \Target

Reference to owning target

methodpublicsetPassword( string $password ) : void
inherited

Sets the password to connect to the database.

Inherited from: \AbstractLiquibaseTask::setPassword()
Parameters
Name Type Description
$password string

the password

methodpublicsetProject( \Project $project ) : void
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::setProject()\AbstractLiquibaseTask::setProject()
Parameters
Name Type Description
$project \Project

The reference to the current project

methodpublicsetRuntimeConfigurableWrapper( \RuntimeConfigurable $wrapper ) : void
inherited

Sets the wrapper object this task should use for runtime configurable elements.

Inherited from: \Task::setRuntimeConfigurableWrapper()\AbstractLiquibaseTask::setRuntimeConfigurableWrapper()
Parameters
Name Type Description
$wrapper \RuntimeConfigurable

The wrapper object this task should use

methodpublicsetTaskName( string $name ) : string
inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()\AbstractLiquibaseTask::setTaskName()
Parameters
Name Type Description
$name string
Returns
Type Description
string A string representing the name of this task for log
methodpublicsetTaskType( string $name ) : void
inherited

Sets the type of the task. Usually this is the name of the XML tag

Inherited from: \Task::setTaskType()\AbstractLiquibaseTask::setTaskType()
Parameters
Name Type Description
$name string

The type of this task (XML Tag)

methodpublicsetUrl( string $url ) : void
inherited

Sets the url to connect to the database in jdbc style, e.g.

Inherited from: \AbstractLiquibaseTask::setUrl()
jdbc:postgresql://psqlhost/mydatabase
Parameters
Name Type Description
$url string

jdbc connection string

methodpublicsetUsername( string $username ) : void
inherited

Sets the username to connect to the database.

Inherited from: \AbstractLiquibaseTask::setUsername()
Parameters
Name Type Description
$username string

the username

methodpublicsetclasspathref( string $classpathref ) : void
inherited

Sets the Java classpathref.

Inherited from: \AbstractLiquibaseTask::setclasspathref()
Parameters
Name Type Description
$classpathref string

A reference to the classpath that contains the database driver, liquibase.jar, and the changelog.xml file

Documentation was generated by DocBlox 0.18.1.