Azure Blob XML File Connector for Python

In this article you will learn how to integrate Azure Blob XML File data in Python (live / bi-directional connection to Azure Blob XML File). Azure Blob XML File Connector can be used to read XML Files stored in Azure Blob Container. Using this you can easily integrate Azure Blob Storage XML File data. It's supports latest security standards, and optimized for large data files. It also supports reading compressed files (e.g. GZip /Zip)..

Using Azure Blob XML File Connector you will be able to connect, read, and write data from within Python. Follow the steps below to see how we would accomplish that.

Download Documentation

Create ODBC Data Source (DSN) based on ZappySys Azure Blob XML Driver

Step-by-step instructions

To get data from Azure Blob XML File using Python we first need to create a DSN (Data Source) which will access data from Azure Blob XML File. We will later be able to read data using Python. Perform these steps:

  1. Install ZappySys ODBC PowerPack.

  2. Open ODBC Data Sources (x64):
    Open ODBC Data Source

  3. Create a User Data Source (User DSN) based on ZappySys Azure Blob XML Driver

    ZappySys Azure Blob XML Driver
    Create new User DSN for ZappySys Azure Blob XML Driver
    You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version.
  4. Create and configure a connection for the Azure Blob storage account.

    Create Azure Blob Storage Connection
  5. You can use select your desired single file by clicking [...] path button.

    mybucket/dbo.tblNames.xml
    dbo.tblNames.xml
    Read Azure Blob XML File data


    ----------OR----------

    You can also read the multiple files stored in Azure Blob Storage using wildcard pattern supported e.g. dbo.tblNames*.xml.

    Note: If you want to operation with multiple files then use wild card pattern as below 
    (when you use wild card pattern in source path then system will treat target path as folder regardless you end with slash)
    
    mybucket/dbo.tblNames.xml (will read only single .XML file)
    mybucket/dbo.tbl*.xml (all files starting with file name)
    mybucket/*.xml (all files with .xml Extension and located under folder subfolder)
    

    mybucket/dbo.tblNames*.xml
    Use wildcard pattern .* to read multiple Azure Blob Files data


    ----------OR----------

    You can also read the zip and gzip compressed files also without extracting it in using Azure Blob XML Source File Task.

    mybucket/dbo.tblNames*.gz
    Reading zip and gzip compressed files (stream mode)
  6. Now select/enter Path expression in Path textbox to extract only specific part of XML string as below ($.value[*] will get content of value attribute from XML document. Value attribute is array of XML documents so we have to use [*] to indicate we want all records of that array)

    NOTE: Here, We are using our desired filter, but you need to select your desired filter based on your requirement.
    Go to Preview Tab.

    Azure Blob XML Driver Select Filter
  7. Navigate to the Preview Tab and let's explore the different modes available to access the data.

    1. --- Using Direct Query ---

      Click on Preview Tab, Select Table from Tables Dropdown and select [value] and click Preview.
      ZappySys ODBC Driver - Preview Data
    2. --- Using Stored Procedure ---

      Note : For this you have to Save ODBC Driver configuration and then again reopen to configure same driver. For more information click here.
      Click on the Custom Objects Tab, Click on Add button and select Add Procedure and Enter an appropriate name and Click on OK button to create.
      ZappySys ODBC Driver - Custom Objects
      1. --- Without Parameters ---

        Now Stored Procedure can be created with or without parameters (see example below). If you use parameters then Set default value otherwise it may fail to compilation)
        ZappySys ODBC Driver : Without Parameters
      2. --- With Parameters ---

        Note : Here you can use Placeholder with Paramters in Stored Procedure. Example : SELECT * FROM $ WHERE OrderID = '<@OrderID, FUN_TRIM>' or CustId = '<@CustId>' and Total >= '<@Total>'
        ZappySys ODBC Driver : With Parameters
    3. --- Using Virtual Table ---

      Note : For this you have to Save ODBC Driver configuration and then again reopen to configure same driver. For more information click here.

      ZappySys APi Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

      Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 Buckets with slight variations you can create virtual tables with just URL as Parameter setting).

      vt__Customers
      DataPath=mybucket_1/customers.xml
      
      vt__Orders
      DataPath=mybucket_2/orders.xml
      
      vt__Products
      DataPath=mybucket_3/products.xml
      
      1. Click on the Custom Objects Tab, Click on Add button and select Add Table and Enter an appropriate name and Click on OK button to create.
        ZappySys ODBC Driver - Custom Objects
      2. Once you see Query Builder Window on screen Configure it.
        ZappySys ODBC Driver - Custom Objects : Virtual Table Query Builder
      3. Click on Preview Tab, Select Virtual Table(prefix with vt__) from Tables Dropdown or write SQL query with Virtual Table name and click Preview.
        ZappySys ODBC Driver - Custom Objects : Virtual Table Query Execute

  8. Click OK to finish creating the data source

  9. That's it; we are done. In a few clicks we configured the to Read the Azure Blob XML File data using ZappySys Azure Blob XML File Connector

Read data in Python

Using ODBC DSN

  1. Python code to get the data:

    AzureBlobXmlFileDSN')
    Python code to get the data from ZappySys DSN

  2. When you run the code it will make the API call and read the data:
    Python - Extracted data from ZappySys DSN

  3. Here is Python program's code in text format:

    
        import pyodbc
        conn = pyodbc.connect('DSN=AzureBlobXmlFileDSN')
    
        cursor = conn.cursor()
    
        #execute query to fetch data from API service
        cursor.execute("SELECT id,title FROM products")
    
        row = cursor.fetchone()
        while row:
            print(row)
            row = cursor.fetchone()
    
        ##For loop example
        #for row in cursor:
        #    print(row)
    

Using a full ODBC connection string

If you want to avoid being dependent on a DSN and creating multiple DSNs for each platform (x86, x64), then you can use a fully qualified connection string. Simply go to your DSN and copy the Connection String:

  1. Open ODBC data source configuration and click Copy settings:
    ZappySys Azure Blob XML Driver - Azure Blob XML File
    Azure Blob XML File Connector can be used to read XML Files stored in Azure Blob Container. Using this you can easily integrate Azure Blob Storage XML File data. It's supports latest security standards, and optimized for large data files. It also supports reading compressed files (e.g. GZip /Zip).
    AzureBlobXmlFileDSN
    Copy connection string for ODBC application
  2. The window opens, telling us the connection string was successfully copied to the clipboard: Successful connection string copying for ODBC application
  3. Then in your Python code use Connection String when initializing OdbcConnection object, for example:

    conn = pyodbc.connect('DRIVER={ZappySys Azure Blob XML Driver};ServiceUrl=https://yourservices.provider.com/api/xxxx....;AuthName=Http;')

How to install `pyodbc` in the Python?

You would need to install pyodbc in Python if you intend to establish connections to databases that support ODBC (Open Database Connectivity). This module facilitates communication between Python applications and various database management systems, enabling you to perform operations such as querying, retrieving data, and managing databases. Here's how you can install pyodbc in Python:

Installation Steps:

  1. Ensure you have Python installed on your system. If not, download it from the official Python website and follow the installation instructions.

  2. Open your terminal or command prompt.

  3. Use the following command to install pyodbc using pip, the Python package installer:

    python -m pip install "pyodbc"

    Make sure you have a stable internet connection and the necessary permissions to install Python packages.


    Python - pip install pyodbc

Reasons to Install:

  • If pyodbc is not installed, your Python script will generate the following error:
    "ModuleNotFoundError: No module named 'pyodbc'"
    .
  • Database Connectivity: pyodbc allows Python to connect to various databases that support ODBC, such as Microsoft SQL Server, PostgreSQL, MySQL, and more.

  • Data Operations: It facilitates the execution of SQL queries, retrieval of data, and other database operations from within Python scripts.

  • Cross-Platform Support: pyodbc is designed to work across different operating systems, including Windows, macOS, and various Linux distributions.

  • Simplicity and Efficiency: The module provides an intuitive interface for managing database transactions and connections, simplifying the process of working with databases in Python.

By installing pyodbc, you can seamlessly integrate your Python applications with a wide range of ODBC-supported databases, enabling efficient and effective data management and analysis.

Advanced topics

Create Custom Stored Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Stored Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Stored Procedure Name

  3. Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
    Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

    CREATE PROCEDURE [usp_get_orders]
        @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
     AS
        SELECT * FROM Orders where OrderDate >= '<@fromdate>';
    

    ZappySys Driver - Create Custom Stored Procedure

  4. That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:

    Exec usp_get_orders '1996-01-01';

    ZappySys Driver - Execute Custom Stored Procedure

  5. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')

    ZappySys Driver - Generate SQL Server Query

  6. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
    Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here

    SELECT
      "ShipCountry",
      "OrderID",
      "CustomerID",
      "EmployeeID",
      "OrderDate",
      "RequiredDate",
      "ShippedDate",
      "ShipVia",
      "Freight",
      "ShipName",
      "ShipAddress",
      "ShipCity",
      "ShipRegion",
      "ShipPostalCode"
    FROM "Orders"
    Where "ShipCountry"='USA'

    ZappySys Driver - Create Custom Table

  5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:

    SELECT * FROM "vt__usa_orders_only"

    ZappySys Driver - Execute Custom Virtual Table Query

  6. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')

    ZappySys Driver - Generate SQL Server Query

  7. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Conclusion

In this article we discussed how to connect to Azure Blob XML File in Python and integrate data without any coding. Click here to Download Azure Blob XML File Connector for Python and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download Azure Blob XML File Connector for Python Documentation 

More integrations

Other application integration scenarios for Azure Blob XML File

Other connectors for Python


Download Azure Blob XML File Connector for Python Documentation

  • How to connect Azure Blob XML File in Python?

  • How to get Azure Blob XML File data in Python?

  • How to read Azure Blob XML File data in Python?

  • How to load Azure Blob XML File data in Python?

  • How to import Azure Blob XML File data in Python?

  • How to pull Azure Blob XML File data in Python?

  • How to push data to Azure Blob XML File in Python?

  • How to write data to Azure Blob XML File in Python?

  • How to POST data to Azure Blob XML File in Python?

  • Call Azure Blob XML File API in Python

  • Consume Azure Blob XML File API in Python

  • Azure Blob XML File Python Automate

  • Azure Blob XML File Python Integration

  • Integration Azure Blob XML File in Python

  • Consume real-time Azure Blob XML File data in Python

  • Consume real-time Azure Blob XML File API data in Python

  • Azure Blob XML File ODBC Driver | ODBC Driver for Azure Blob XML File | ODBC Azure Blob XML File Driver | SSIS Azure Blob XML File Source | SSIS Azure Blob XML File Destination

  • Connect Azure Blob XML File in Python

  • Load Azure Blob XML File in Python

  • Load Azure Blob XML File data in Python

  • Read Azure Blob XML File data in Python

  • Azure Blob XML File API Call in Python