Difference between revisions of "XML"

From Recital Documentation Wiki
Jump to: navigation, search
 
(3 intermediate revisions by one user not shown)
Line 1: Line 1:
{{YLM to do}}
+
Extensible Markup Language (XML) allows data and data structures to be defined in an agreed format so that they can be shared.  Recital and SQL commands support the export of Recital data to XML format and the import of XML data into Recital format.  Recital also includes a series of functions for accessing XML files and their associated Document Type Definition (DTD) files.
 
+
Extensible Markup Language (XML) allows data and data structures to be defined in an agreed format so that they can be shared.  The Recital 4GL and Recital SQL provide commands to export Recital data in XML format and import XML data into Recital format.  The Recital 4GL also includes a series of functions for accessing XML files and their associated Document Type Definition (DTD) files.
+
  
  
Line 10: Line 8:
  
 
Note: The XMLFORMAT setting determines whether Recital creates an accompanying DTD file when creating XML files. A DTD file is only created when XMLFORMAT is set to Recital.
 
Note: The XMLFORMAT setting determines whether Recital creates an accompanying DTD file when creating XML files. A DTD file is only created when XMLFORMAT is set to Recital.
 
  
 
* [[SET XMLFORMAT]] - Toggle XML file format (RECITAL/ADO).
 
* [[SET XMLFORMAT]] - Toggle XML file format (RECITAL/ADO).
Line 16: Line 13:
  
 
==Exporting Recital data in XML format==
 
==Exporting Recital data in XML format==
 
 
* [[COPY TO|COPY TO ... TYPE XML]] - The COPY TO command allows records from the active table to be copied out in XML format (RECITAL/ADO).
 
* [[COPY TO|COPY TO ... TYPE XML]] - The COPY TO command allows records from the active table to be copied out in XML format (RECITAL/ADO).
 
   
 
   
* [[SQL SELECT|SELECT ... SAVE AS XML]] - The Recital/SQL SELECT command allows data from one or more tables or views to be saved in XML format (RECITAL/ADO).
+
* [[SQL SELECT|SELECT ... SAVE AS XML]] - The SQL SELECT command allows data from one or more tables or views to be saved in XML format (RECITAL/ADO).
 
   
 
   
* [[FETCH|FETCH ... INTO XML]] - The Recital/SQL FETCH command allows individual rows from a SELECT statement to be saved into a RECITAL XML format file.
+
* [[FETCH|FETCH ... INTO XML]] - The SQL FETCH command allows individual rows from a SELECT statement to be saved into a RECITAL XML format file.
  
 
* [[XML_SCATTER()]] - Save the contents of the current record in XML format to a character string.
 
* [[XML_SCATTER()]] - Save the contents of the current record in XML format to a character string.
Line 27: Line 23:
  
 
==Importing XML data into Recital format==
 
==Importing XML data into Recital format==
 
+
* [[CREATE TABLE|CREATE TABLE...FROM XML]] - The SQL CREATE command allows a Recital table to be created from a structure or structure and data from an ADO XML format file.
* [[CREATE TABLE|CREATE TABLE...FROM XML]] - The Recital/SQL UPDATE command allows a Recital table to be created from a structure or structure and data from an ADO XML format file.
+
 
   
 
   
* [[SQL INSERT|INSERT...FROM XML]] - The Recital/SQL UPDATE command allows a Recital table to be updated with data from an ADO XML format file.
+
* [[SQL INSERT|INSERT...FROM XML]] - The SQL INSERT command allows a Recital table to be updated with data from an ADO XML format file.
 
+
* [[SQL UPDATE|UPDATE ... FROM XML]] - The Recital/SQL UPDATE command allows a Recital table to be updated with data from a RECITAL XML format file.
+
  
 
* [[XML_GATHER()]] - Write the contents of a character string containing XML format data into the current record.
 
* [[XML_GATHER()]] - Write the contents of a character string containing XML format data into the current record.
Line 38: Line 31:
  
 
==Functions for accessing XML and DTD files==
 
==Functions for accessing XML and DTD files==
 
 
* [[XMLCOUNT()]] - Function to return the number of records from an XML file.
 
* [[XMLCOUNT()]] - Function to return the number of records from an XML file.
 
   
 
   
Line 49: Line 41:
 
* [[XMLVALIDATE()]] - Function to return the number of records from an XML file.
 
* [[XMLVALIDATE()]] - Function to return the number of records from an XML file.
  
 +
 +
==Functions for passing objects between processes==
 +
* [[XML_DECODE()]] - Convert a character string containing XML format data to an object.
 +
 +
* [[XML_ENCODE()]] - Convert an object to a character string containing XML format data
  
  
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Reference]]
 
[[Category:Reference]]
 +
[[Category:XML]]

Latest revision as of 09:21, 7 January 2010

Extensible Markup Language (XML) allows data and data structures to be defined in an agreed format so that they can be shared. Recital and SQL commands support the export of Recital data to XML format and the import of XML data into Recital format. Recital also includes a series of functions for accessing XML files and their associated Document Type Definition (DTD) files.


Format of XML files

The format for XML files can be either RECITAL or ADO (Microsoft® ActiveX® Data Objects). Any XML files created in the ADO format can be loaded with the Open method of an ADO Recordset object.

The default XMLFORMAT setting is ADO. The default XMLFORMAT setting can be changed using the SET XMLFORMAT command or overridden using the FORMAT clause on the SQL SELECT statement.

Note: The XMLFORMAT setting determines whether Recital creates an accompanying DTD file when creating XML files. A DTD file is only created when XMLFORMAT is set to Recital.


Exporting Recital data in XML format

  • COPY TO ... TYPE XML - The COPY TO command allows records from the active table to be copied out in XML format (RECITAL/ADO).
  • SELECT ... SAVE AS XML - The SQL SELECT command allows data from one or more tables or views to be saved in XML format (RECITAL/ADO).
  • FETCH ... INTO XML - The SQL FETCH command allows individual rows from a SELECT statement to be saved into a RECITAL XML format file.
  • XML_SCATTER() - Save the contents of the current record in XML format to a character string.


Importing XML data into Recital format

  • CREATE TABLE...FROM XML - The SQL CREATE command allows a Recital table to be created from a structure or structure and data from an ADO XML format file.
  • INSERT...FROM XML - The SQL INSERT command allows a Recital table to be updated with data from an ADO XML format file.
  • XML_GATHER() - Write the contents of a character string containing XML format data into the current record.


Functions for accessing XML and DTD files

  • XMLCOUNT() - Function to return the number of records from an XML file.
  • XMLCREATEDTD() - Function to create a Document Type Definition file for a particular table.
  • XMLFIRST() - Function to read the first record contained in the specified XML file.
  • XMLNEXT() - Function to read the next record contained in the XML file specified with the XMLFIRST() function.
  • XMLVALIDATE() - Function to return the number of records from an XML file.


Functions for passing objects between processes

  • XML_DECODE() - Convert a character string containing XML format data to an object.
  • XML_ENCODE() - Convert an object to a character string containing XML format data