SQLAlchemy ORM を使って、Python でADP データに連携

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

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムADP data データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。ADP に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接ADP 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います（特にJOIN やSQL 関数など）。

ADP Data への接続

ADP data への連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

Connect to ADP by specifying the following properties:

• SSLClientCert: Set this to the certificate provided during registration.
• SSLClientCertPassword: Set this to the password of the certificate.
• UseUAT: The connector makes requests to the production environment by default. If using a developer account, set UseUAT = true.
• RowScanDepth: The maximum number of rows to scan for the custom fields columns available in the table. The default value will be set to 100. Setting a high value may decrease performance.

The connector uses OAuth to authenticate with ADP. OAuth requires the authenticating user to interact with ADP using the browser. For more information, refer to the OAuth section in the Help documentation.

以下の手順でSQLAlchemy をインストールして、Python オブジェクトからADP に接続します。

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でADP Data をモデル化します

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

engine = create_engine("adp///?OAuthClientId=YourClientId&OAuthClientSecret=YourClientSecret&SSLClientCert='c:\cert.pfx'&SSLClientCertPassword='admin@123'InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

ADP Data のマッピングクラスの宣言

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

base = declarative_base()
class Workers(base):
	__tablename__ = "Workers"
	AssociateOID = Column(String,primary_key=True)
	WorkerID = Column(String)
	...

ADP Data をクエリ

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

query メソッドを使う

engine = create_engine("adp///?OAuthClientId=YourClientId&OAuthClientSecret=YourClientSecret&SSLClientCert='c:\cert.pfx'&SSLClientCertPassword='admin@123'InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Workers).filter_by(AssociateOID="G3349PZGBADQY8H8"):
	print("AssociateOID: ", instance.AssociateOID)
	print("WorkerID: ", instance.WorkerID)
	print("---------")

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

execute メソッドを使う

Workers_table = Workers.metadata.tables["Workers"]
for instance in session.execute(Workers_table.select().where(Workers_table.c.AssociateOID == "G3349PZGBADQY8H8")):
	print("AssociateOID: ", instance.AssociateOID)
	print("WorkerID: ", instance.WorkerID)
	print("---------")

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

ADP Data の挿入（INSERT）

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

new_rec = Workers(AssociateOID="placeholder", AssociateOID="G3349PZGBADQY8H8")
session.add(new_rec)
session.commit()

ADP Data を更新（UPDATE）

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

updated_rec = session.query(Workers).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.AssociateOID = "G3349PZGBADQY8H8"
session.commit()

ADP Data を削除（DELETE）

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

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

製品の無償トライアル情報

ADP Python Connector の30日の無償トライアル をぜひダウンロードして、ADP data への接続をPython アプリやスクリプトから簡単に作成しましょう。