SAP ByDesign のデータにPythonで接続する方法｜CData Connect AI SDK

Jerod Johnson
Director, Technology Evangelism

PythonのDB-API 2.0準拠コードでリアルタイムのSAP ByDesign のデータを読み取る方法を解説。CData Connect AI Python SDKとPAT認証で、pip install1つから10分で接続を実現します。

CData Connect AI Python SDK を使うと、標準的なDB-API 2.0のPythonコードでSAP ByDesign のデータをそのまま読み書きできます。プログラミング不要の他ツールと異なり、pandasやpetlなど既存のPythonエコシステムにそのまま組み込めます。パッケージのインストールからクエリ実行まで3ステップで完了します。

CData Connect AI Python SDK（cdata-connect-ai）は DB-API 2.0（PEP 249）に準拠したクライアントで、標準的な Python のデータベースコードでリアルタイムのSAP ByDesign のデータを取得・操作できます。接続まわりは Connect AI が引き受けてくれるので、パッケージを1つインストールしてパーソナルアクセストークンで認証するだけで、SAP ByDesign（および Connect AI に接続済みのその他すべてのソース）にクエリを実行できます。しかも sqlite3 や psycopg2 といったライブラリでおなじみの connect() / cursor() / fetchall() という同じパターンをそのまま使えます。

この記事では、Connect AI で SAP ByDesign に接続し、パーソナルアクセストークンを生成して SDK をインストールし、リアルタイムのSAP ByDesign のデータを読み取る（対応している場合は書き込む）までの流れをご紹介します。

事前準備

CData Connect AI のアカウント
Python 3.8 以降
有効な認証情報を持つアクティブな SAP ByDesign アカウント

Connect AI で SAP ByDesign に接続する方法は？

CData Connect AI では、直感的なクリック操作ベースのインターフェースでデータソースに接続できます。

Connect AI にログインし、Sources をクリックして、 Add Connection をクリックします

「Add Connection」パネルから「SAP ByDesign」を選択します

SAP ByDesign に接続するために必要な認証プロパティを入力します。
SAP ByDesign に接続するには、次の接続プロパティを設定します。
- Url: SAP ByDesign サイトのURL に設定。例：https://test.sapbydesign.com
- User: アカウントのユーザー名に設定。
- Password: アカウントのパスワードに設定。
- CustomService or AnalyticsService: いずれか一方のみを指定する必要があります。データを取得するカスタムサービスがある場合はCustomService を指定します。アナリティクスサービスのレポートを取得する場合はAnalyticsService を指定します。どちらも指定されていない場合は、'cc_home_analytics.svc' がAnalyticsService プロパティのデフォルトとして使用されます。指定するサービスがわからない場合は、Services ビューをクエリして利用可能なサービスを一覧表示できます。
「Save & Test」をクリックします
「Permissions」タブに移動し、ユーザーベースの権限を更新します。

パーソナルアクセストークン（PAT）を生成する

Python SDK は、アカウントのメールアドレスとパーソナルアクセストークン（PAT）を使って Connect AI に認証します。アクセスの粒度を保つために、アプリケーションごとに個別の PAT を作成することをおすすめします。

Connect AI アプリの右上にある歯車アイコン（）をクリックして、設定ページを開きます。
設定ページの Access Tokens セクションに移動し、 Create PAT をクリックします。
PAT に名前を付けて Create をクリックします。
パーソナルアクセストークンは作成時にのみ表示されます。必ずコピーして安全な場所に保管してください。

SDK をインストールする

pip を使って PyPI から SDK をインストールします。

pip install cdata-connect-ai

接続して最初のクエリを実行する

アカウントのメールアドレスと PAT で接続したら、sys_tables にクエリを実行して、接続済みのソース全体で利用可能なテーブルを確認してみましょう。Connect AI の識別子は <Connection>.<Schema>.<Table> という3つの部分で構成されており、接続名はデフォルトでソース名（例：SAPByDesign1）になります。

import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)
cur = conn.cursor()

# Discover what's available across your connected sources
cur.execute("SELECT CatalogName, SchemaName, TableName FROM sys_tables LIMIT 25")

for row in cur.fetchall():
    print(row)

結果から任意のテーブルを選び、直接クエリを実行してみましょう。

cur.execute(
    "SELECT ID, ProductCategoryID "
    "FROM [SAPByDesign1].[SAPByDesign].[[Inventory Balance]] "
    "LIMIT 10"
)

for row in cur.fetchall():
    print(row)

SAP ByDesign は Connect AI では読み取り専用のソースのため、SDK はクエリには対応していますが、INSERT、UPDATE、DELETE には対応していません。作業が終わったら接続を閉じましょう。

conn.close()

これがワークフローのすべてです。パッケージが1つ、PAT、そして標準的な DB-API 呼び出しだけ。SDK は通常の DB-API 接続を返すので、Python のデータエコシステムのほかのツールにもそのまま組み込めます。ここから先は、この同じ接続を使って、SAP ByDesign のデータを pandas に読み込んだり、petl で ETL パイプラインを構築したり、Dash の Web アプリを動かしたりできます。

SAP ByDesign のデータにPythonで接続する方法｜CData Connect AI SDK

事前準備

Connect AI で SAP ByDesign に接続する方法は？

パーソナルアクセストークン（PAT）を生成する

SDK をインストールする

接続して最初のクエリを実行する

関連情報と無料トライアル

はじめる準備はできましたか？

この記事の内容

関連記事