ADOdb

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== extractSchema ======
~~NOTOC~~
<WRAP right box>
== See Also ==
[[v5:axmls:parseschemafile]]
== Syntax ==
  string extractSchema (
    optional bool $data = false,
    optional string $indent = '  ',
    optional string $prefix = '',
    optional bool $stripprefix = false
    )
</WRAP>
===== Description =====
Extracts a XML schema from an existing database.

Call this method to create an XML schema string from an existing database. If the data parameter is set to TRUE, AXMLS will include the data from the database in the schema.

The method returns a generated XML schema.

===== Parameters =====
==== $data ====
Include data from the database tables in schema dump. There are a number of issues that affect the successful outcome of use of this option:
  * The size of the tables being dumped
  * The database in use
  * PHP memory configuration.

Because the method results in the entire database being held in a single string variable, a good rule of thumb is that if a single table contains more than 1,000 records then it would be more appropriate to consider use of a database specific data dump utility.
==== $indent ====
The indentation character(s) to use. The default value is '  ' (2 spaces). Other alternatives might be "\t" (tab).
==== $prefix ====
Only match tables with this prefix. Pattern match wildcards are not supported by this option.
==== $stripprefix ====
Strips the prefix string from table names when storing in XML schema. This option works in conjunction with the $prefix option. For example, if required table names were all prefixed with e.g. 'abc_', then selecting 'abc_' would only retrieve those tables, and setting this option to true would remove that option before saving the data. 

===== Return =====
The method returns a string containing the schema, and if requested, the data inside the tables.

===== Database Migration =====
For small databases, use of this method paired with [[v5:axmls:parseschemafile]] provides an easy to use database schema and data migration tool.