SQLAlchemy ORM を使って、Python でSFTP データに連携する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for SFTP は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで SFTP にデータ連携するPython アプリケーションを構築し、SFTP データを可視化できます。 本記事では、SQLAlchemy でSFTP に連携して、データを取得、、更新、挿入、削除 する方法を説明します。

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. SFTP をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Python をはじめとする多様なデータ分析・BI ツールにSFTP データを連携
3. ノーコードでの手軽な接続設定

CData Python Connectors では、1.データソースとしてSFTP の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

必要なモジュールのインストール

pip でSQLAlchemy ツールキットをインストールします：

pip install sqlalchemy

モジュールのインポートを忘れずに行います：

import sqlalchemy

Python でSFTP データをモデル化

次は、接続文字列で接続を確立します。create_engine 関数を使って、SFTP データに連携するEngne を作成します。

engine = create_engine("sftp///?RemoteHost=MyFTPServer")

FTP は、SFTP プロトコルを使用してSFTP サーバーとの間のファイル転送を行います。接続するにはRemoteHost を指定します。FTP はUser、Password、および公開鍵認証（SSHClientCert）を使用します。 SSHAuthMode を選択し、選択に基づいて接続値を指定します。

次の接続プロパティを設定し、ファイルシステムのリレーショナルビューをコントロールします。

• RemotePath: 現在の作業ディレクトリに設定。
• TableDepth: ビューとしてレポートするサブフォルダの深度を制御するために設定。
• FileRetrievalDepth: ファイルを再帰的に取得し、Root テーブルにリストするために設定。

SFTP データのマッピングクラスの宣言

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、MyDirectory テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。

base = declarative_base()
class MyDirectory(base):
	__tablename__ = "MyDirectory"
	Filesize = Column(String,primary_key=True)
	Filename = Column(String)
	...

SFTP データをクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。

query メソッドを使う

engine = create_engine("sftp///?RemoteHost=MyFTPServer")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(MyDirectory).filter_by(FilePath="/documents/doc.txt"):
	print("Filesize: ", instance.Filesize)
	print("Filename: ", instance.Filename)
	print("---------")

ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。

execute メソッドを使う

MyDirectory_table = MyDirectory.metadata.tables["MyDirectory"]
for instance in session.execute(MyDirectory_table.select().where(MyDirectory_table.c.FilePath == "/documents/doc.txt")):
	print("Filesize: ", instance.Filesize)
	print("Filename: ", instance.Filename)
	print("---------")

より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

SFTP データの挿入（INSERT）

SFTP データへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、SFTP にすべての追加インスタンスを送ります。

new_rec = MyDirectory(Filesize="placeholder", FilePath="/documents/doc.txt")
session.add(new_rec)
session.commit()

SFTP データを更新（UPDATE）

SFTP データの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、SFTP にレコードを追加します。

updated_rec = session.query(MyDirectory).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.FilePath = "/documents/doc.txt"
session.commit()

SFTP データを削除（DELETE）

SFTP データの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。

deleted_rec = session.query(MyDirectory).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()

SFTP からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。