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

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Create ETL applications and real-time data pipelines for Egnyte 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 API Driver for Python and the petl framework, you can build Egnyte-connected applications and pipelines for extracting, transforming, and loading Egnyte data. This article shows how to connect to Egnyte with the CData Python Connector and use petl and pandas to extract, transform, and load Egnyte data.

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

Connecting to Egnyte Data

Connecting to Egnyte 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.

Start by setting the Profile connection property to the location of the Egnyte Profile on disk (e.g. C:\profiles\Egnyte.apip). Next, set the ProfileSettings connection property to the connection string for Egnyte (see below).

Egnyte API Profile Settings

Register a developer account with Egnyte and create an OAuth application to receive a Client ID and Secret. Your domain is extracted from your Egnyte URL.

After installing the CData Egnyte Connector, follow the procedure below to install the other required modules and start accessing Egnyte 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 Egnyte 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.api as mod

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

cnxn = mod.connect("Profile=C:\profiles\Egnyte.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;")

Create a SQL Statement to Query Egnyte

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

sql = "SELECT Id, Path FROM Bookmarks WHERE FolderId = 'example_folder_id'"

Extract, Transform, and Load the Egnyte Data

With the query results stored in a DataFrame, we can use petl to extract, transform, and load the Egnyte data. In this example, we extract Egnyte data, sort the data by the Path column, and load the data into a CSV file.

Loading Egnyte Data into a CSV File

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'Path')

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

With the CData API Driver for Python, you can work with Egnyte 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 API Driver for Python to start building Python apps and scripts with connectivity to Egnyte 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.api as mod

cnxn = mod.connect("Profile=C:\profiles\Egnyte.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;")

sql = "SELECT Id, Path FROM Bookmarks WHERE FolderId = 'example_folder_id'"

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'Path')

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

Ready to get started?

Connect to live data from Egnyte with the API Driver

Connect to Egnyte