VOOZH about

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

⇱ Build a PostgreSQL Interface for XML Data using the CData JDBC Driver


Build a PostgreSQL Interface for XML Data using the CData JDBC Driver

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use the Remoting features of the XML JDBC Driver to create a PostgreSQL entry-point for data access.

There are a vast number of PostgreSQL clients available on the Internet. From standard Drivers to BI and Analytics tools, PostgreSQL is a popular interface for data access. Using our JDBC Drivers, you can now create PostgreSQL entry-points that you can connect to from any standard client.

To access XML data as a PostgreSQL database, use the CData JDBC Driver for XML and a JDBC foreign data wrapper (FDW). In this article, we compile the FDW, install it, and query XML data from PostgreSQL Server.

Connect to XML Data as a JDBC Data Source

To connect to XML as a JDBC data source, you will need the following:

  • Driver JAR path: The JAR is located in the lib subfolder of the installation directory.
  • Driver class:

    cdata.jdbc.xml.XMLDriver
    
  • JDBC URL: The URL must start with "jdbc:xml:" and can include any of the connection properties in name-value pairs separated with semicolons.

    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;
    

Build the JDBC Foreign Data Wrapper

The Foreign Data Wrapper can be installed as an extension to PostgreSQL, without recompiling PostgreSQL. The jdbc2_fdw extension is used as an example (downloadable here).

  1. Add a symlink from the shared object for your version of the JRE to /usr/lib/libjvm.so. For example:
    ln -s /usr/lib/jvm/java-6-openjdk/jre/lib/amd64/server/libjvm.so /usr/lib/libjvm.so
    
  2. Start the build:
    make install USE_PGXS=1
    

Query XML Data as a PostgreSQL Database

After you have installed the extension, follow the steps below to start executing queries to XML data:

  1. Log into your database.
  2. Load the extension for the database:
    CREATE EXTENSION jdbc2_fdw;
    
  3. Create a server object for XML:
    CREATE SERVER XML 
    FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS (
    drivername 'cdata.jdbc.xml.XMLDriver',
    url 'jdbc:xml:URI=C:/people.xml;DataModel=Relational;',
    querytimeout '15',
    jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.xml.jar'); 
    
  4. Create a user mapping for the username and password of a user known to the MySQL daemon.
    CREATE USER MAPPING for postgres SERVER XML OPTIONS (
    username 'admin', 
    password 'test');
    
  5. Create a foreign table in your local database:
    postgres=# CREATE FOREIGN TABLE people (
    people_id text,
    people_[ personal.name.first ] text,
    people_[ personal.name.last ] numeric) 
    SERVER XML OPTIONS (
    table_name 'people');
    
You can now execute read/write commands to XML:
postgres=# SELECT * FROM people;

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.