VOOZH about

URL: https://www.cdata.com/kb/tech/xml-jdbc-ads.rst

⇱ Connect to XML Data in Aqua Data Studio


Connect to XML Data in Aqua Data Studio

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Access XML data from tools in Aqua Data Studio such as the Visual Query Builder and the Table Data Editor.

The CData JDBC Driver for XML integrates XML data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to XML data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The XML data source can then be accessed from Aqua Data Studio tools.

  1. In Aqua Data Studio, select Register Server from the Servers menu.
  2. In the Register Server form, select the 'Generic - JDBC' connection.
  3. Enter the following JDBC connection properties:
    • Name: Enter a name for the data source; for example, XML.
    • Driver Location: Click the Browse button and select the cdata.jdbc.xml.jar file, located in the lib subfolder of the installation directory.
    • Driver: Enter the Driver's class name, cdata.jdbc.xml.XMLDriver.
    • URL: Enter the JDBC URL, which starts with jdbc:xml: and is followed by a semicolon-separated list of connection properties.

      Connecting to Local or Cloud-Stored (Box, Google Drive, Amazon S3, SharePoint) XML Files

      CData Drivers let you work with XML files stored locally and stored in cloud storage services like Box, Amazon S3, Google Drive, or SharePoint, right where they are.

      Setting connection properties for local files

      Set the URI property to local folder path.

      Setting connection properties for files stored in Amazon S3

      To connect to XML file(s) within Amazon S3, set the URI property to the URI of the Bucket and Folder where the intended XML files exist. In addition, at least set these properties:

      • AWSAccessKey: AWS Access Key (username)
      • AWSSecretKey: AWS Secret Key

      Setting connection properties for files stored in Box

      To connect to XML file(s) within Box, set the URI property to the URI of the folder that includes the intended XML file(s). Use the OAuth authentication method to connect to Box.

      Dropbox

      To connect to XML file(s) within Dropbox, set the URI proprerty to the URI of the folder that includes the intended XML file(s). Use the OAuth authentication method to connect to Dropbox. Either User Account or Service Account can be used to authenticate.

      SharePoint Online (SOAP)

      To connect to XML file(s) within SharePoint with SOAP Schema, set the URI proprerty to the URI of the document library that includes the intended XML file. Set User, Password, and StorageBaseURL.

      SharePoint Online REST

      To connect to XML file(s) within SharePoint with REST Schema, set the URI proprerty to the URI of the document library that includes the intended XML file. StorageBaseURL is optional. If not set, the driver will use the root drive. OAuth is used to authenticate.

      Google Drive

      To connect to XML file(s) within Google Drive, set the URI property to the URI of the folder that includes the intended XML file(s). Use the OAuth authentication method to connect and set InitiateOAuth to GETANDREFRESH.

      The property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

      • Document (default): Model a top-level, document view of your XML data. The data provider returns nested elements as aggregates of data.
      • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
      • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

      See the Modeling XML Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the XML JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.xml.jar
      

      Fill in the connection properties and copy the connection string to the clipboard.

      👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
      A typical JDBC URL is below:
      jdbc:xml:URI=C:/people.xml;DataModel=Relational;
    👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. (QuickBooks is shown.)

Query XML Data

You can now query the tables exposed.

👁 A query executed in the Table Data Editor. (QuickBooks is shown.)

Ready to get started?

Download a free trial of the XML Driver to get started:

 Download Now

Learn more:

👁 XML Documents Icon
XML JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with XML data stores.