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/11/16 00:54] – mnewnham | axmls:extractschema [2015/12/15 02:23] – mnewnham | ||
---|---|---|---|
Line 4: | Line 4: | ||
== Syntax == | == Syntax == | ||
string extractSchema ( | string extractSchema ( | ||
- | optional bool $data = FALSE | + | optional bool $includeData |
+ | optional string $indent = ' ', | ||
+ | optional string $prefix = '', | ||
+ | optional bool $stripprefix = false | ||
) | ) | ||
</ | </ | ||
Line 14: | Line 17: | ||
The method returns a generated XML schema. | The method returns a generated XML schema. | ||
+ | ===== Parameters ===== | ||
+ | ==== $includeData ==== | ||
+ | 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 ==== | ||
+ | The indentation character to use. The default value is ' ' | ||
+ | ==== $prefix ==== | ||
+ | Only match tables with this prefix. Patten match wildcards are not supported by this option. | ||
+ | ==== $stripprefix ==== | ||
+ | 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. |
v5/axmls/extractschema.txt · Last modified: 2020/12/30 01:03 by peterdd