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

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

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

DocuSign Data への接続

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

DocuSign への接続には以下の接続プロパティを設定します:

• UseSandbox: UseSandbox は現在のユーザーアカウントがサンドボックスかそうでないかを示します。デフォルトはfalse です。サンドボックスアカウントがある場合はTrue に設定します。
• AccountId (optional): 認証が成功すると自動的に設定されます。 または、複数のAccount Id にアクセスできる場合は、接続文字列で手動で設定できます。アカウントId を取得するには、UserInfo ビューをクエリします。

DocuSign への認証

DocuSign はOAuth 認証標準を利用しています。OAuth を使って認証するには、アプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得しなければなりません。認証方法については、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。

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

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

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

pip install sqlalchemy

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

import sqlalchemy

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

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

engine = create_engine("docusign///?OAuthClientId=MyClientId& OAuthClientSecret=MyClientSecret& 
CallbackURL=http://localhost:33333&
InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

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

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

base = declarative_base()
class Documents(base):
	__tablename__ = "Documents"
	DocumentId = Column(String,primary_key=True)
	DocumentName = Column(String)
	...

DocuSign Data をクエリ

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

query メソッドを使う

engine = create_engine("docusign///?OAuthClientId=MyClientId& OAuthClientSecret=MyClientSecret& 
CallbackURL=http://localhost:33333&
InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Documents).filter_by(DocumentName="TPSReport"):
	print("DocumentId: ", instance.DocumentId)
	print("DocumentName: ", instance.DocumentName)
	print("---------")

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

execute メソッドを使う

Documents_table = Documents.metadata.tables["Documents"]
for instance in session.execute(Documents_table.select().where(Documents_table.c.DocumentName == "TPSReport")):
	print("DocumentId: ", instance.DocumentId)
	print("DocumentName: ", instance.DocumentName)
	print("---------")

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

DocuSign Data の挿入（INSERT）

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

new_rec = Documents(DocumentId="placeholder", DocumentName="TPSReport")
session.add(new_rec)
session.commit()

DocuSign Data を更新（UPDATE）

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

updated_rec = session.query(Documents).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.DocumentName = "TPSReport"
session.commit()

DocuSign Data を削除（DELETE）

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

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

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

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