SQLAlchemy ORM を使用して Python で LDAP Objects にアクセスする方法

Python の豊富なモジュールエコシステムを活用することで、迅速に作業を開始し、システムを効果的に統合できます。CData Python Connector for LDAP と SQLAlchemy ツールキットを使用して、LDAP に接続された Python アプリケーションやスクリプトを構築できます。この記事では、SQLAlchemy を使用して LDAP objects に接続し、クエリ、更新、削除、挿入を実行する方法を説明します。

CData Python Connector は最適化されたデータ処理機能を内蔵しており、Python からリアルタイムの LDAP objects を操作する際に比類のないパフォーマンスを提供します。LDAP に対して複雑な SQL クエリを発行すると、CData Connector はフィルタや集計などのサポートされている SQL 操作を直接 LDAP にプッシュし、サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンを使用してクライアント側で処理します。

LDAP Objects への接続

LDAP objects への接続は、他のリレーショナルデータソースへの接続と同様です。必要な接続プロパティを使用して接続文字列を作成します。この記事では、接続文字列を create_engine 関数のパラメータとして渡します。

リクエストを認証するには、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：このプロパティを使用すると、サブツリーから返されるデータをより細かく制御できます。

以下の手順に従って SQLAlchemy をインストールし、Python オブジェクトを通じて LDAP にアクセスしてみましょう。

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

pip ユーティリティを使用して、SQLAlchemy ツールキットと SQLAlchemy ORM パッケージをインストールします。

pip install sqlalchemy
pip install sqlalchemy.orm

適切なモジュールをインポートします。

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Python での LDAP Objects のモデリング

これで接続文字列を使用して接続できます。create_engine 関数を使用して、LDAP objects を操作するための Engine を作成します。

注意: 接続文字列のプロパティに特殊文字が含まれている場合は、URL エンコードする必要があります。詳細については、SQL Alchemy ドキュメントを参照してください。

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

LDAP Objects のマッピングクラスの宣言

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

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

LDAP Objects のクエリ

マッピングクラスを準備したら、セッションオブジェクトを使用してデータソースにクエリを実行できます。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、集計、制限などのより複雑なクエリの例については、拡張機能のヘルプドキュメントを参照してください。

LDAP Objects の挿入

LDAP objects を挿入するには、マッピングクラスのインスタンスを定義し、アクティブな session に追加します。セッションの commit 関数を呼び出して、追加されたすべてのインスタンスを LDAP にプッシュします。

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

LDAP Objects の更新

LDAP objects を更新するには、フィルタクエリで目的のレコードを取得します。次に、フィールドの値を変更し、セッションの commit 関数を呼び出して、変更されたレコードを LDAP にプッシュします。

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

LDAP Objects の削除

LDAP objects を削除するには、フィルタクエリで目的のレコードを取得します。次に、アクティブな session でレコードを削除し、セッションの commit 関数を呼び出して、指定されたレコード（行）に対して削除操作を実行します。

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

無料トライアルと詳細情報

CData Python Connector for LDAP の30日間の無料トライアルをダウンロードして、LDAP objects に接続する Python アプリとスクリプトの構築を始めましょう。ご質問がありましたら、サポートチームまでお問い合わせください。