v5:axmls:extractschema
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
axmls:extractschema [2015/12/15 01:28] – mnewnham | v5:axmls:extractschema [2020/12/30 01:03] (current) – typos and sync params with source code peterdd | ||
---|---|---|---|
Line 2: | Line 2: | ||
~~NOTOC~~ | ~~NOTOC~~ | ||
<WRAP right box> | <WRAP right box> | ||
+ | == See Also == | ||
+ | [[v5: | ||
== Syntax == | == Syntax == | ||
string extractSchema ( | string extractSchema ( | ||
- | optional bool $includeData | + | optional bool $data = false, |
- | optional string $indent = ' ', | + | optional string $indent = ' |
optional string $prefix = '', | optional string $prefix = '', | ||
optional bool $stripprefix = false | optional bool $stripprefix = false | ||
Line 11: | Line 13: | ||
</ | </ | ||
===== Description ===== | ===== Description ===== | ||
- | Extracts | + | Extracts |
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. | 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. | ||
Line 18: | Line 20: | ||
===== Parameters ===== | ===== Parameters ===== | ||
- | ==== $includeData | + | ==== $data ==== |
- | Include data from the database in schema dump | + | Include data from the database |
+ | * 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(s) to use. The default value is ' |
==== $prefix ==== | ==== $prefix ==== | ||
- | Only match tables with this prefix. | + | Only match tables with this prefix. Pattern match wildcards are not supported by this option. |
==== $stripprefix ==== | ==== $stripprefix ==== | ||
- | strip prefix string when storing in XML schema | + | Strips the prefix string |
+ | |||
+ | ===== 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: |
v5/axmls/extractschema.txt · Last modified: 2020/12/30 01:03 by peterdd