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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でNetSuite のデータをモデル化

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

engine = create_engine("netsuite///?Account Id=XABC123456&Password=password&User=user&Role Id=3&Version=2013_1")

Netsuite への接続

NetSuite は現在、2つの異なるAPI を提供しています。

• SuiteTalk はNetSuite との通信に使用する、SOAP ベースのより古いサービスです。多くのエンティティを幅広くサポートし、INSERT / UPDATE / DELETE を完全にサポートします。 しかしデータの抽出用ツールは低機能で、SELECT 時のパフォーマンスは極めて低いです。テーブルを結合するよい方法もありません。データのグループ化および集計はこのAPI からは利用できず、 そのためこれらの操作をサポートするには、すべてをクライアントサイドで実行しなければなりません。
• SuiteQL は新しいAPI です。サービスとのSQL ライクな通信方法を実現するため、JOIN の機能はより豊富になり、GROUP BY や集計機能もサポートします。 加えて、抽出したいカラムだけを取得する機能も完全にサポートします。そのため、データを抽出する際のパフォーマンスがSuiteTalk より大幅に向上しています。ただし、サポートされるのはデータの抽出のみです。

NetSuite に接続するには、以下を行う必要があります。

1. Schema を設定して、接続に使用するAPI を指定。データを取得するだけの場合は、SuiteQL の使用をお勧めします。データの取得および変更が必要な場合は、SuiteTalk の使用をお勧めします。
2. 使用するAPI に適した接続オプションを設定します。（それぞれのAPI で利用可能な接続オプションが異なります。ヘルプドキュメントの「許可の設定」を参照してください。）

Netsuite への認証

SuiteTalk またはSuiteQL

NetSuite は3つの形式のOAuth 認証を提供します。

• トークンベース認証（TBA）は、基本的にOAuth 1.0 で、OAuthAccessToken とOAuthAccessTokenSecret を実行時ではなくNetSuite UI 内で作成します。 TBA は、2020.2 以降のSuiteTalk およびSuiteQL の両方で利用可能です。
• OAuth 2.0 認証は、SuiteQL でのみ利用できます。OAuth 2.0 認証を強制するには、次のいずれかを実行します。
  • OAuthVersion を使用するAPI に明示的に設定、または
  • Schema をSuiteQL に設定
• OAuth JWT 認証は、OAuth 2.0 クライアント認証フローであり、クライアント認証情報を含むJWT を使用してNetSuite データへのアクセスを要求します。この認証方法は、Schema がSuiteQL に設定されている場合にのみ使用できます。

認証方法の詳細はヘルプドキュメントの「はじめに」を参照してください。

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

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

base = declarative_base()
class SalesOrder(base):
	__tablename__ = "SalesOrder"
	CustomerName = Column(String,primary_key=True)
	SalesOrderTotal = Column(String)
	...

NetSuite のデータをクエリ

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

query メソッドを使う

engine = create_engine("netsuite///?Account Id=XABC123456&Password=password&User=user&Role Id=3&Version=2013_1")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(SalesOrder).filter_by(Class_Name="Furniture : Office"):
	print("CustomerName: ", instance.CustomerName)
	print("SalesOrderTotal: ", instance.SalesOrderTotal)
	print("---------")

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

execute メソッドを使う

SalesOrder_table = SalesOrder.metadata.tables["SalesOrder"]
for instance in session.execute(SalesOrder_table.select().where(SalesOrder_table.c.Class_Name == "Furniture : Office")):
	print("CustomerName: ", instance.CustomerName)
	print("SalesOrderTotal: ", instance.SalesOrderTotal)
	print("---------")

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

NetSuite のデータの挿入（INSERT）

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

new_rec = SalesOrder(CustomerName="placeholder", Class_Name="Furniture : Office")
session.add(new_rec)
session.commit()

NetSuite のデータを更新（UPDATE）

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

updated_rec = session.query(SalesOrder).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Class_Name = "Furniture : Office"
session.commit()

NetSuite のデータを削除（DELETE）

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

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

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

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

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