class PropelDataDumpTask extends AbstractPropelDataModelTask
Dumps the content of selected databases to XML data dump file.
The results of the data dump can be converted to SQL using the PropelDataSQLTask class.
The database may be specified (via 'databaseName' attribute) if you only want to dump the contents of one database. Otherwise it is assumed that all databases described by datamodel schema file(s) will be dumped.
Properties
$conn | The database connection used to retrieve the data to dump. |
Methods
List |
getDataModels()
Return the data models that have been processed. |
from AbstractPropelDataModelTask |
Hashtable |
getDataModelDbMap()
Return the data model to database name map. |
from AbstractPropelDataModelTask |
addSchemaFileset(Fileset $set)
Adds a set of xml schema files (nested fileset attribute). |
from AbstractPropelDataModelTask | |
String |
getTargetDatabase()
Get the current target database. |
from AbstractPropelDataModelTask |
setTargetDatabase($v $v)
Set the current target database. |
from AbstractPropelDataModelTask | |
string |
getTargetPackage()
Get the current target package. |
from AbstractPropelDataModelTask |
setTargetPackage(string $v)
Set the current target package. |
from AbstractPropelDataModelTask | |
setPackageObjectModel(boolean $v)
Set the packageObjectModel switch on/off |
from AbstractPropelDataModelTask | |
setValidate(boolean $v)
Set whether to perform validation on the datamodel schema.xml file(s). |
from AbstractPropelDataModelTask | |
setXsd(PhingFile $v)
Set the XSD schema to use for validation of any datamodel schema.xml file(s). |
from AbstractPropelDataModelTask | |
setXsl(PhingFile $v)
Set the normalization XSLT to use to transform datamodel schema.xml file(s) before validation and parsing. |
from AbstractPropelDataModelTask | |
void |
setOutputDirectory(PhingFile $outputDirectory)
[REQUIRED] Set the output directory. |
from AbstractPropelDataModelTask |
setDbEncoding($v $v)
Set the current target database encoding. |
from AbstractPropelDataModelTask | |
setUrl(string $url)
Set the DB connection url. |
from AbstractPropelDataModelTask | |
setUserid(string $userId)
Set the user name for the DB connection. |
from AbstractPropelDataModelTask | |
setPassword(string $password)
Set the password for the DB connection. |
from AbstractPropelDataModelTask | |
string |
getOutputDirectory()
Get the output directory. |
from AbstractPropelDataModelTask |
Mapper |
createMapper()
Nested creator, creates one Mapper for this task. |
from AbstractPropelDataModelTask |
PDO |
getConnection()
Gets the PDO connection, if URL specified. |
from AbstractPropelDataModelTask |
void |
setDataDbMap(PhingFile $datadbmap)
Set the file that maps between data XML files and databases. |
|
PhingFile |
getDataDbMap()
Get the file that maps between data XML files and databases. |
|
The |
getDatabaseName()
Get the database name to dump |
|
setDatabaseName($v $v)
Set the database name |
||
The |
getDatabaseUrl()
Get the database url |
|
setDatabaseUrl(string $v)
Set the database url |
||
string |
getDatabaseUser()
Get the database user |
|
setDatabaseUser(string $v)
Set the database user |
||
string |
getDatabasePassword()
Get the database password |
|
setDatabasePassword(string $v)
Set the database password |
||
string |
getDatabaseDriver()
Get the database driver name |
|
setDatabaseDriver(string $v)
Set the database driver name |
||
void |
main()
Iterates through each datamodel/database, dumps the contents of all tables and creates a DOM XML doc. |
Details
in AbstractPropelDataModelTask at line 158
public List
getDataModels()
Return the data models that have been processed.
in AbstractPropelDataModelTask at line 172
public Hashtable
getDataModelDbMap()
Return the data model to database name map.
in AbstractPropelDataModelTask at line 186
public
addSchemaFileset(Fileset $set)
Adds a set of xml schema files (nested fileset attribute).
in AbstractPropelDataModelTask at line 196
public String
getTargetDatabase()
Get the current target database.
in AbstractPropelDataModelTask at line 206
public
setTargetDatabase($v $v)
Set the current target database.
(e.g. mysql, oracle, ..)
in AbstractPropelDataModelTask at line 216
public string
getTargetPackage()
Get the current target package.
in AbstractPropelDataModelTask at line 227
public
setTargetPackage(string $v)
Set the current target package.
This is where generated PHP classes will live.
in AbstractPropelDataModelTask at line 237
public
setPackageObjectModel(boolean $v)
Set the packageObjectModel switch on/off
in AbstractPropelDataModelTask at line 247
public
setValidate(boolean $v)
Set whether to perform validation on the datamodel schema.xml file(s).
in AbstractPropelDataModelTask at line 257
public
setXsd(PhingFile $v)
Set the XSD schema to use for validation of any datamodel schema.xml file(s).
in AbstractPropelDataModelTask at line 267
public
setXsl(PhingFile $v)
Set the normalization XSLT to use to transform datamodel schema.xml file(s) before validation and parsing.
in AbstractPropelDataModelTask at line 281
public void
setOutputDirectory(PhingFile $outputDirectory)
[REQUIRED] Set the output directory.
It will be created if it doesn't exist.
in AbstractPropelDataModelTask at line 301
public
setDbEncoding($v $v)
Set the current target database encoding.
in AbstractPropelDataModelTask at line 311
public
setUrl(string $url)
Set the DB connection url.
in AbstractPropelDataModelTask at line 321
public
setUserid(string $userId)
Set the user name for the DB connection.
in AbstractPropelDataModelTask at line 331
public
setPassword(string $password)
Set the password for the DB connection.
in AbstractPropelDataModelTask at line 341
public string
getOutputDirectory()
Get the output directory.
in AbstractPropelDataModelTask at line 352
public Mapper
createMapper()
Nested creator, creates one Mapper for this task.
in AbstractPropelDataModelTask at line 394
public PDO
getConnection()
Gets the PDO connection, if URL specified.
at line 89
public void
setDataDbMap(PhingFile $datadbmap)
Set the file that maps between data XML files and databases.
at line 99
public PhingFile
getDataDbMap()
Get the file that maps between data XML files and databases.
at line 109
public The
getDatabaseName()
Get the database name to dump
at line 119
public
setDatabaseName($v $v)
Set the database name
at line 129
public The
getDatabaseUrl()
Get the database url
at line 139
public
setDatabaseUrl(string $v)
Set the database url
at line 150
public string
getDatabaseUser()
Get the database user
at line 162
public
setDatabaseUser(string $v)
Set the database user
at line 172
public string
getDatabasePassword()
Get the database password
at line 184
public
setDatabasePassword(string $v)
Set the database password
at line 194
public string
getDatabaseDriver()
Get the database driver name
at line 204
public
setDatabaseDriver(string $v)
Set the database driver name
at line 256
public void
main()
Iterates through each datamodel/database, dumps the contents of all tables and creates a DOM XML doc.