製品をチェック

Square Data Provider の30日間無償トライアルをダウンロード

 30日間の無償トライアルへ

製品の詳細

Square アイコン Square ADO.NET Provider 相談したい

Square のTransaction、Items、Subscriptions データを.NET ベースのアプリケーションから手軽に連携。

Blazor でSquare のデータにリアルタイムで連携するアプリを構築

ASP.NET Core Blazor C# でSquare にSQL でクエリ。

杉本和也
リードエンジニア

最終更新日:2021-11-03
square ロゴ

CData

ado ロゴ画像
Blazor ロゴ

こんにちは!リードエンジニアの杉本です。

Blazor は、.NET を使って対話型のクライアント側Web UI を構築するためのフレームワークです。JavaScript の代わりにC# を使って、UI を作れるところが魅力です。また、既存の.NET ライブラリや.NET エコシステムを使うことができる利点があります。

CData ADO.NET Provider for Square は、LINQ やEntity Framework などの標準のADO.NET インターフェースを使ってSquare を操作可能にします。Blazor が.NET Core 対応をしているため、Server Side Blazor からADO.NET Provider を使うことができます。この記事では、Server Side Blazor からSquare に接続して直接SQL クエリを実行する方法を説明します。

Blazor はADO.NET Provider の利用が可能

CData ADO.NET Provider for Square のインストール

CData ADO.NET Provider は、通常であればRDB に接続するフレームワークである ADO.NET DataAdapter やLinqToSQL(もしくはDapper などのORM を挟んでもいいです)であり、Square のデータへもRDB と同感覚でアクセスが可能になります。

CData のWebsite からProvider をダウンロードして、マシンにインストールします。NuGet からインストールすることも可能です。Square ADO.NET Data Provider で検索してください。

NuGet でADO.NET Square Provider をインストール

Blazor でSquare にデータ連携するアプリを構築

Blazor にADO.NET Provider for Square を接続

  • Visual Studio を立ち上げて、Blazor アプリのプロジェクトを作成します。
  • Blazor アプリを作成
  • ソリューションエクスプローラーで「依存関係」から右クリックで「プロジェクト参照の追加」をクリック。
  • 参照マネージャーが開くので、「参照」ボタンをクリックして、先ほどインストールしたADO.NET Provider の.dll を選択します。「C:\Program Files\CData\CData ADO.NET Provider for Square 2019J\lib etstandard2.0」内のSystem.Data.CData.Square.dll」を参照に選びます。
  • ADO.NET for Square の.dll をBlazor アプリから参照

Blazor でSquare のデータをSELECT

サンプルプロジェクトの「Page」→「Index.razor」を開きます。

以下のコードを書きます。使っているクエリはおなじみの標準SQL です。Square 固有のAPI を書かなくてもRDB と同感覚でSQL が書けるところがADO.NET Prover for Square の強味です。
@page "/" @using System.Data; @using System.Data.CData.Square;

Hello, world!

Welcome to your Data app.
@using (SquareConnection connection = new SquareConnection( "OAuthClientId=MyAppId;OAuthClientSecret=MyAppSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation;")) { var sql = "SELECT Reason, RefundedMoneyAmount FROM Refunds"; var results = new DataTable(); SquareDataAdapter dataAdapter = new SquareDataAdapter(sql, connection); dataAdapter.Fill(results); @foreach (DataColumn item in results.Rows[0].Table.Columns) { } @foreach (DataRow row in results.Rows) { @foreach (var column in row.ItemArray) { } }
@item.ColumnName
@column.ToString()
}

Square OAuth 認証標準を使用します。OAuth を使用して認証するには、Square にアプリを登録してOAuthClientId、OAuthClientSecret、CallbackURL を入手します。OAuth の使用方法については、ヘルプドキュメントの「はじめに」セクションをご覧ください。

追加でLocationId を指定する必要がある場合があります。Locations テーブルをクエリすることでLocations のId を取得できます。または、クエリの検索項目にLocationId を設定することもできます。

プロジェクトをリビルドして実行します。このようにSquare からデータを直接取得し、HTML テーブル形式にレンダリングしています。

Blazor アプリからSquare のデータをクエリ

もちろんSaaS データソースへの接続の場合には、RDB 向けのドライバーと違い最終的にはHTTP リクエストが行われるので、サーバーサイド Blazor としてサーバーサイドから実行されるのか、クライアントサイド Blazor として、実行中のブラウザからHTTPリクエストが行われるのかの違いはあります。そのあたりはネットワークやプロキシの設定として注意が必要でしょう。設定はコード内の接続プロパティで可能です。

まとめ

このようにサーバーサイドBlazor アプリから簡単にADO.NET Provider を使ってSquare にリアルタイムでデータ取得を行うアプリを作ることができました。Blazor が.NET Core、フレームワークのツール群を使えるというメリットを活かすことができます。今回はSELECT * でしたが、フィルタリングやJOIN も可能です。INSERT、UPDATE、DELETE も標準SQL で書くことができます。是非、30日の無償評価版でシンプルかつパワフルなADO.NET Provider でのサーバーサイドBlazor 連携をお試しください。

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。