ImportFromXml¶
Imports xml data to specified table. Please see DataTable.ImportFromXml for more details.
1 |
|
Parameters¶
QueryWithMappings query
Query object to import
Remarks¶
This method is a wrapper method for DataTable.ImportFromXml and DataTable.Save method.
The design of your XML data model and SQL table columns are the key point for the ease of use. When XML node and table column names identical, this method maps them automatically.
Map Function¶
Map function is used to transform values before saving. For example; encrypting a password before saving to database. See $Database.ExportToXml
for more details.
Example¶
1 2 3 4 5 6 7 8 9 10 11 12 13 |
|
Common use case for importing data¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
|
Customized Column Update¶
1 2 3 4 5 6 7 8 9 10 11 12 |
|
Info
By default all matching columns and data model elements are automatically updated by name. If your table columns and data model names are different you can provide a "Map" function to manually map columns to your data model.
Update Only Selected Columns¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
|
Nested Insert and Update¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
|
Saving columns with their related single/multiple entities is handled as below.
Column Update with SubQueries¶
1 2 3 4 5 6 7 8 9 10 11 |
|
Assume you have the XML below as your form data, two SQL tables Corporations and SubCorporations, and a One-To-Many relation from Corporations table to SubCorporations table which is also named SubCorporations.
Warning
Cascade Option
Don't forget to set this relation's update rule to "Cascade" to update with sub queries. Having defined the table columns with identical names to the XML fields, this code lets you save each corporation from XML data into the SQL table, saving also its related SubCorporations into the related SQL table.
Form XML Example¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
|
Types¶
QueryWithMappings¶
Columns
: Array<QueryColumn>
Array of columns
Map
: (node: Xml) => void
MaxLength
: number
Maximum number of rows. If not set all rows are returns.
Node
: Xml
Root node of mapping. If not specified $Xml instance is used.
Order
: Array<QueryOrder>
Array of order columns
Parameters
: object
Additional parameters
Start
: number
Start index of rows.
SubQueries
: Array<SubQuery>
Array of sub queries.
TargetSchema
: string
Name of schema to execute query on.
TargetTable
: string
Name of table to execute query on.
Where
: QueryBlock
Criteria of query
XPath
: string
Root xpath to be mapped.
QueryColumn¶
Defines a query column to included in result
Expression
: string
Expression of column.
Name
: string
Name of column to use in results. If not specified expression is used.
XPath
: string
XPath to be mapped.
QueryOrder¶
Defines order expression of query result
Expression
: string
Expression to order.
Type
: ( "Ascending"
| "Descending"
)
Type of ordering. If not specified Ascending is used.
SubQuery¶
Columns
: Array<QueryColumn>
Array of columns
MaxLength
: number
Maximum number of rows. If not set all rows are returns.
Name
: string
Name of sub query. Relation name can be used as name.
Order
: Array<QueryOrder>
Array of order columns
Parameters
: object
Additional parameters
Relation
: string
Name of relation
Start
: number
Start index of rows.
SubQueries
: Array<SubQuery>
Array of sub queries.
TargetSchema
: string
Name of schema to execute query on.
TargetTable
: string
Name of table to execute query on.
Where
: QueryBlock
Criteria of query
XPath
: string
Specifies the target xpath to export data on.
QueryBlock¶
Blocks
: Array<QueryBlock>
Array of criteria blocks
Condition
: ( "And"
| "Or"
)
Condition with next block. If not specified And value is used.
Criteria
: Array<QueryCriteria>
Array of criteria
QueryCriteria¶
Defines a criteria to be used to filter results
Comparison
: ( "Equals"
| "Different"
| "LessThan"
| "GreaterThan"
| "LessThanOrEqualTo"
| "GreaterThanOrEqualTo"
| "Like"
)
Comparison operator. Default value is Equals.
Condition
: ( "And"
| "Or"
)
Condition with next criteria. If not specified And value is used.
Expression
: string
Criteria expression.
IgnoredValues
: any
Array of ignored values.
Value
: any
Value or Expression to compare
ValueType
: ( "Direct"
| "Expression"
)
Type of value. If not specified Direct value is used.