Jump to main content Jump to doc navigation


Parses an existing database and generates a XPDO XML schema from it.


API Docs: http://api.modxcms.com/xpdo/om-mysql/xPDOGenerator_mysql.html#writeSchema

boolean writeSchema (
  string $schemaFile,
  [string $package = ''],
  [string $baseClass = ''],
  [string $tablePrefix = ''],
  [boolean $restrictPrefix = false])


Generate the xml schema from an existing database. This also only generates XML for the tables prefixed with 'mydb_'.

$xpdo= new xPDO('mysql:host=localhost;dbname=myolddatabase','username','password','mydb_');
$manager= $xpdo->getManager();
$generator= $manager->getGenerator();

$xml= $generator->writeSchema('/path/to/my/new/packagename.schema.xml','mypackage', 'xPDOObject','mydb_');

Note: generating the XML schema doesn't generate the aggregate and composite relationships - just the field and object definitions. You'll need to specify those relationships yourself. See Defining Relationships for more details.

See Also

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.


  • modmore
  • Jens Wittmann – Gestaltung & Entwicklung
  • Fabian Christen
  • Dannevang Digital
  • Digital Penguin
  • Sepia River Studios
  • deJaya
  • Following Sea
  • Chris Fickling
  • CrewMark
  • Anton Tarasov
  • eydolan
  • Raffy
  • Lefthandmedia
  • Murray Wood
  • Nick Clark
  • Helen
  • Snow Creative
  • YJ
  • krisznet
  • Richard
  • Yanni
  • JT Skaggs


$393 per month—let's make that $500!

Learn more