v5:axmls:extractschema
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
axmls:extractschema [2015/12/15 01:28] – mnewnham | v5:axmls:extractschema [2016/01/13 02:26] – ↷ Page moved from axmls:extractschema to v5:axmls:extractschema mnewnham | ||
---|---|---|---|
Line 2: | Line 2: | ||
~~NOTOC~~ | ~~NOTOC~~ | ||
<WRAP right box> | <WRAP right box> | ||
+ | == See Also == | ||
+ | [[axmls: | ||
== Syntax == | == Syntax == | ||
string extractSchema ( | string extractSchema ( | ||
Line 19: | Line 21: | ||
===== Parameters ===== | ===== Parameters ===== | ||
==== $includeData ==== | ==== $includeData ==== | ||
- | Include data from the database in schema dump | + | Include data from the database 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 ==== | ==== $indent ==== | ||
- | The indentation character to use. | + | The indentation character to use. The default value is ' ' |
==== $prefix ==== | ==== $prefix ==== | ||
- | Only match tables with this prefix. | + | Only match tables with this prefix. Patten match wildcards are not supported by this option. |
==== $stripprefix ==== | ==== $stripprefix ==== | ||
- | strip prefix string when storing in XML schema | + | strip prefix string 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. ' |
+ | |||
+ | ===== 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 [[axmls: |
v5/axmls/extractschema.txt · Last modified: 2020/12/30 01:03 by peterdd