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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でHCL Domino のデータをモデル化

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

engine = create_engine("domino///?Server=https://domino.corp.com&Database=names.nsf&Port=3002&SSLClientCertType=PEMKEY_FILE&SSLClientCert=full_path_of_certificate.pem&SSLServerCert=*")

Domino への接続

Domino のデータに接続するには、以下のプロパティを設定してください。

• URL: Domino データベースをホスティングしているサーバーのホスト名、またはIP を入力します。サーバーのポート番号を含めてください。例えば、http://sampleserver:1234/。
• DatabaseScope: Domino Web UI 内のスコープ名を入力します。ドライバーは、ここで指定したスコープによって制御されるスキーマの、フォームとビューを公開します。Domino Admin UI で、サイドバーからScopes メニューを選択します。このプロパティを、既存のスコープ名に設定します。

Domino での認証

Domino は、ログインクレデンシャルまたはAzure Active Directory OAuth アプリケーションを使用した認証をサポートしています。

ログインクレデンシャル

ログインクレデンシャルで認証するには、以下のプロパティを設定してください：

• AuthScheme: これを"OAuthPassword" に設定します
• User: 認証するDomino ユーザーのユーザー名
• Password: 認証するDominoユ ーザーに関連付けられたパスワード

ドライバーはログインクレデンシャルを使用して、自動的にOAuth トークン交換を実行します。

AzureAD

この認証方法は、Azure Active Directory をIdP として使用してJWTトークンを取得します。Azure Active Directory にカスタムのアプリケーションを作成し、それをIdP として設定する必要があります。そのためには、ヘルプドキュメントの指示に従ってください。その後、以下のプロパティを設定します。

• AuthScheme: これを"AzureAD" に設定します
• InitiateOAuth: これをGETANDREFRESH に設定します。InitiateOAuth を使用すると、OAuth 交換の繰り返しやOAuthAccessToken の手動設定を避けることができます。
• OAuthClientId: カスタムOAuth アプリケーションのセットアップ時に取得したクライアントID
• OAuthClientSecret: カスタムOAuth アプリケーションのセットアップ時に取得したクライアントシークレット
• CallbackURL: アプリ登録時に定義したリダイレクトURI。例えば、https://localhost:33333
• AzureTenant: データにアクセスするために使用されるMicrosoft Online テナント。companyname.microsoft.com 形式の値またはテナントID のいずれかを指定してください。

  テナントID は、Azure ポータルのAzure Active Directory > プロパティページに表示されているディレクトリID と同じです。

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

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

base = declarative_base()
class ByName(base):
	__tablename__ = "ByName"
	Name = Column(String,primary_key=True)
	Address = Column(String)
	...

HCL Domino のデータをクエリ

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

query メソッドを使う

engine = create_engine("domino///?Server=https://domino.corp.com&Database=names.nsf&Port=3002&SSLClientCertType=PEMKEY_FILE&SSLClientCert=full_path_of_certificate.pem&SSLServerCert=*")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(ByName).filter_by(City="Miami"):
	print("Name: ", instance.Name)
	print("Address: ", instance.Address)
	print("---------")

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

execute メソッドを使う

ByName_table = ByName.metadata.tables["ByName"]
for instance in session.execute(ByName_table.select().where(ByName_table.c.City == "Miami")):
	print("Name: ", instance.Name)
	print("Address: ", instance.Address)
	print("---------")

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

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

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

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