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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でLDAP データをモデル化

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

engine = create_engine("ldap///?User=Domain\BobF&Password=bob123456&Server=10.0.1.1&Port=389")

リクエストを認証するには、User およびPassword プロパティを有効なLDAP クレデンシャル（例えば、User を"Domain\BobF" または"cn=Bob F,ou=Employees,dc=Domain"）に設定します。 CData 製品は、デフォルトでプレーンテキスト認証を使用します。これは、CData 製品がサーバーとTLS/SSL のネゴシエーションを試みるためです。 AuthMechanism を使って別の認証方法を指定できます。 TLS/SSL コンフィギュレーションについて詳しくは、ヘルプドキュメントの「高度な設定」を参照してください。

基本接続には、Server およびPort を設定します。さらに、次のように接続を微調整できます。
• FollowReferrals：設定すると、CData 製品は参照サーバーのデータもビューとして表示します。参照サーバー上のデータを変更するには、このサーバーをServer およびPort で指定する必要があります。
• LDAPVersion：サーバーが実装するプロトコルのバージョンに設定します。デフォルトでは、CData 製品はversion 2 を使用します。
• BaseDN は、LDAP 検索の範囲を指定された識別名の高さに限定します。BaseDN の範囲を絞ることはパフォーマンスを劇的に向上させます。例えば、"cn=users,dc=domain" の値は、"cn=users" およびその子に含まれる結果のみを返します。
• Scope：このプロパティを使用すると、サブツリーから返されるデータをより細かく制御できます。

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

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

base = declarative_base()
class User(base):
	__tablename__ = "User"
	Id = Column(String,primary_key=True)
	LogonCount = Column(String)
	...

LDAP データをクエリ

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

query メソッドを使う

engine = create_engine("ldap///?User=Domain\BobF&Password=bob123456&Server=10.0.1.1&Port=389")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(User).filter_by(CN="Administrator"):
	print("Id: ", instance.Id)
	print("LogonCount: ", instance.LogonCount)
	print("---------")

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

execute メソッドを使う

User_table = User.metadata.tables["User"]
for instance in session.execute(User_table.select().where(User_table.c.CN == "Administrator")):
	print("Id: ", instance.Id)
	print("LogonCount: ", instance.LogonCount)
	print("---------")

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

LDAP データの挿入（INSERT）

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

new_rec = User(Id="placeholder", CN="Administrator")
session.add(new_rec)
session.commit()

LDAP データを更新（UPDATE）

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

updated_rec = session.query(User).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.CN = "Administrator"
session.commit()

LDAP データを削除（DELETE）

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

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

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

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

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