How to Build an ETL App for FTP Data in Python with CData Connect AI

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

The Connect AI Python SDK (cdata-connect-ai) is a DB-API 2.0 (PEP 249) compliant client, so petl can read directly from the SDK connection with etl.fromdb. There is no driver to install per source: connect with a Personal Access Token and build your pipeline.

Connect to FTP in Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "FTP" from the Add Connection panel

3. Enter the necessary authentication properties to connect to FTP.

   To connect to FTP or SFTP servers, specify at least RemoteHost and FileProtocol. Specify the port with RemotePort.

   Set User and Password to perform Basic authentication. Set SSHAuthMode to use SSH authentication. See the Getting Started section of the data provider help documentation for more information on authenticating via SSH.

   Set SSLMode and SSLServerCert to secure connections with SSL.

   The data provider lists the tables based on the available folders in your FTP server. Set the following connection properties to control the relational view of the file system:

   • RemotePath: Set this to the current working directory.
   • TableDepth: Set this to control the depth of folders to list as views.
   • FileRetrievalDepth: Set this to retrieve and list files recursively from the root table.

   Stored Procedures are available to download files, upload files, and send protocol commands. See the Data Model chapter of the FTP data provider documentation for more information.

   
4. Click Save & Test
5. Navigate to the Permissions tab and update the user-based permissions.

Generate a Personal Access Token (PAT)

The Python SDK authenticates to Connect AI with your account email and a Personal Access Token (PAT). It is best practice to create a separate PAT for each application to maintain granularity of access.

1. Click the Gear icon () at the top right of the Connect AI app to open the Settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The PAT is only visible at creation, so copy it and store it securely.

Install Required Modules

Install the SDK and the petl framework using the pip utility:

pip install cdata-connect-ai
pip install petl

Build an ETL App for FTP Data in Python

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

First, import the modules and connect to Connect AI with your account email and PAT:

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

Create a SQL Statement to Query FTP

Use SQL to create a statement for querying FTP. In this article, we read data from the MyDirectory entity. Identifiers are three-part: <Connection>.<Schema>.<Table>, where the connection name defaults to the source name (for example, FTP1).

sql = (
    "SELECT Filesize, Filename "
    "FROM [FTP1].[FTP].[MyDirectory] "
    "WHERE FilePath = '/documents/doc.txt'"
)

Extract, Transform, and Load the FTP Data

With a connection and query in hand, use petl to extract, transform, and load the FTP data. In this example, we extract FTP data, sort the data by the Filename column, and load the data into a CSV file.

table1 = etl.fromdb(conn, sql)

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

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

Load New Rows Back into FTP

When FTP supports writes, load rows back with a batch INSERT. The SDK's executemany takes @name placeholders and a list of parameter dictionaries, one per row.

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [FTP1].[FTP].[MyDirectory] (Filesize, Filename) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")

conn.close()

Note: Even for writable sources, a read-only PAT or connection permission will reject write operations.

With the CData Connect AI Python SDK, you can work with FTP data just like you would with any database, including direct access to data in ETL packages like petl.

More Information and Free Trial

Now you can pipe live FTP data through petl using the CData Connect AI Python SDK. For more information on connecting to FTP (and hundreds of other data sources), visit the Connect AI page. Sign up for a free trial and start building data pipelines for live FTP data in Python.

Full Source Code

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

sql = (
    "SELECT Filesize, Filename "
    "FROM [FTP1].[FTP].[MyDirectory] "
    "WHERE FilePath = '/documents/doc.txt'"
)

table1 = etl.fromdb(conn, sql)

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

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

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [FTP1].[FTP].[MyDirectory] (Filesize, Filename) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")
conn.close()