VOOZH about

URL: https://www.cdata.com/kb/tech/xml-python-petl.rst

⇱ How to Build an ETL App for XML Data in Python with CData


How to Build an ETL App for XML Data in Python with CData

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Create ETL applications and real-time data pipelines for XML data in Python with petl.

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Python Connector for XML and the petl framework, you can build XML-connected applications and pipelines for extracting, transforming, and loading XML data. This article shows how to connect to XML with the CData Python Connector and use petl and pandas to extract, transform, and load XML data.

With built-in, optimized data processing, the CData Python Connector offers unmatched performance for interacting with live XML data in Python. When you issue complex SQL queries from XML, the driver pushes supported SQL operations, like filters and aggregations, directly to XML and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to XML Data

Connecting to XML data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

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.

After installing the CData XML Connector, follow the procedure below to install the other required modules and start accessing XML through Python objects.

Install Required Modules

Use the pip utility to install the required modules and frameworks:

pip install petl
pip install pandas

Build an ETL App for XML Data in Python

Once the required modules and frameworks are installed, we are ready to build our ETL app. Code snippets follow, but the full source code is available at the end of the article.

First, be sure to import the modules (including the CData Connector) with the following:

import petl as etl
import pandas as pd
import cdata.xml as mod

You can now connect with a connection string. Use the connect function for the CData XML Connector to create a connection for working with XML data.

cnxn = mod.connect("URI=C:/people.xml;DataModel=Relational;")

Create a SQL Statement to Query XML

Use SQL to create a statement for querying XML. In this article, we read data from the people entity.

sql = "SELECT [ personal.name.first ], [ personal.name.last ] FROM people WHERE [ personal.name.last ] = 'Roberts'"

Extract, Transform, and Load the XML Data

With the query results stored in a DataFrame, we can use petl to extract, transform, and load the XML data. In this example, we extract XML data, sort the data by the [ personal.name.last ] column, and load the data into a CSV file.

Loading XML Data into a CSV File

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'[ personal.name.last ]')

etl.tocsv(table2,'people_data.csv')

In the following example, we add new rows to the people table.

Adding New Rows to XML

table1 = [ ['[ personal.name.first ]','[ personal.name.last ]'], ['New[ personal.name.first ]1','New[ personal.name.last ]1'], ['New[ personal.name.first ]2','New[ personal.name.last ]2'], ['New[ personal.name.first ]3','New[ personal.name.last ]3'] ]

etl.appenddb(table1, cnxn, 'people')

With the CData Python Connector for XML, you can work with XML data just like you would with any database, including direct access to data in ETL packages like petl.

Free Trial & More Information

Download a free, 30-day trial of the CData Python Connector for XML to start building Python apps and scripts with connectivity to XML data. Reach out to our Support Team if you have any questions.



Full Source Code

import petl as etl
import pandas as pd
import cdata.xml as mod

cnxn = mod.connect("URI=C:/people.xml;DataModel=Relational;")

sql = "SELECT [ personal.name.first ], [ personal.name.last ] FROM people WHERE [ personal.name.last ] = 'Roberts'"

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'[ personal.name.last ]')

etl.tocsv(table2,'people_data.csv')

table3 = [ ['[ personal.name.first ]','[ personal.name.last ]'], ['New[ personal.name.first ]1','New[ personal.name.last ]1'], ['New[ personal.name.first ]2','New[ personal.name.last ]2'], ['New[ personal.name.first ]3','New[ personal.name.last ]3'] ]

etl.appenddb(table3, cnxn, 'people')

Ready to get started?

Download a Community License of the XML Connector to get started:

 Download Now

Learn more:

👁 XML Documents Icon
XML Python Connector

Python Connector Libraries for XML Documents Data Connectivity. Integrate XML Documents with popular Python tools like Pandas, SQLAlchemy, Dash & petl.