C++Builder でLinear のデータにデータバインドするコントロールを作成
CData ODBC ドライバー for Linear を使用すると、C++Builder の標準データアクセスコンポーネントを使ってライブのLinear のデータ への接続を簡単に統合できます。この記事では、C++Builder でシンプルな VCL(Visual Component Library)アプリケーションを作成し、Linear のデータ に接続してクエリを実行し、グリッドに結果を表示する方法を説明します。さらに、FireDAC コンポーネントを使ってコードからコマンドを実行する方法も紹介します。
Linear のデータへの接続を作成
まだ設定していない場合は、ODBC DSN(データソース名)で接続プロパティを指定します。これはドライバーインストールの最終ステップです。Microsoft ODBC データソースアドミニストレーターを使って ODBC DSN を作成・設定できます。
Linear への認証には、個人用 API キーまたは OAuth 2.0 を使用できます。ご自身の Linear アカウントで接続する場合は、API キーを使うのが最も手軽です。
API キーによる認証
以下の接続プロパティを設定します。
- AuthScheme:APIKey に設定します。
- APIKey:Linear の個人用 API キー。
個人用 API キーを作成するには、Linear にログインして Settings > Security & access > Personal API keys を開き、New API key を選択して作成します。キーは一度しか表示されないため、すぐにコピーしておきましょう。
OAuth による認証
OAuth を使用するには、Linear にカスタム OAuth アプリケーションを登録する必要があります(Settings > API > OAuth applications)。登録すると OAuthClientId と OAuthClientSecret が発行されます。対応しているフローは以下の 2 つです。
- Authorization code:AuthScheme を OAuth、InitiateOAuth を GETANDREFRESH に設定し、OAuthClientId、OAuthClientSecret、およびアプリケーションで定義した CallbackURL(例:http://localhost:33333)を指定します。ドライバーがブラウザで Linear を開くので、アクセスを許可してください。
- Client credentials:AuthScheme を OAuthClient に設定し、OAuthClientId と OAuthClientSecret を指定します。アプリケーション自体を認証するためブラウザ操作は不要で、マシン間(M2M)連携に適しています。
デフォルトでは、ドライバーは read,write スコープをリクエストします。アクセストークンは有効期限が切れると自動で更新されます。
次に、以下の手順に従って Data Explorer を使用し、Linear への FireDAC 接続を作成します。
- 新しい VCL Forms アプリケーションで、Data Explorer の FireDAC ノードを展開します。
- Data Explorer の ODBC Data Source ノードを右クリックします。
- Add New Connection をクリックします。
- 接続の名前を入力します。
- 表示される FireDAC Connection Editor で、DataSource プロパティをLinear の ODBC DSN の名前に設定します。
Linear のデータに接続する VCL アプリケーションを作成
以下の手順に従って、クエリの結果をグリッドに表示するシンプルな VCL アプリケーションからLinear のデータ のクエリを開始します。
-
TFDConnection コンポーネントをフォームにドロップし、以下のプロパティを設定します:
- ConnectionDefName:Linear への FireDAC 接続を選択します。
- Connected:メニューから True を選択し、表示されるダイアログで資格情報を入力します。
-
TFDQuery コンポーネントをフォームにドロップし、以下のプロパティを設定します:
- Connection:TFDConnection コンポーネントに設定します(まだ指定されていない場合)。
SQL:SQL プロパティのボタンをクリックし、クエリを入力します。例:
SELECT id, name FROM Team WHERE key = 'ENG'- Active:このプロパティを true に設定します。
TDataSource コンポーネントをフォームにドロップし、以下のプロパティを設定します:
- DataSet:このプロパティのメニューで、TFDQuery コンポーネントの名前を選択します。
-
TDBGrid コントロールをフォームにドロップし、以下のプロパティを設定します:
- DataSource:TDataSource の名前を選択します。
- TFDGUIxWaitCursor をフォームにドロップします — これは実行時エラーを回避するために必要です。
FireDAC コンポーネントを使ってLinear にコマンドを実行
TFDConnection および TFQuery コンポーネントを使用して、Linear のデータ にクエリを実行できます。このセクションでは、TFQuery コンポーネントを使ったクエリ実行のLinear 固有の例を紹介します。
Linear のデータに接続
データソースに接続するには、TFDConnection コンポーネントの Connected プロパティを true に設定します。コードから同じプロパティを設定することもできます:
FDConnection1->ConnectionDefName = "CData Linear ODBC Source";
FDConnection1->Connected = true;
TFDQuery コンポーネントをLinear のデータ に接続するには、コンポーネントの Connection プロパティを設定します。設計時に TFDQuery コンポーネントを追加すると、上記のアプリケーションのように、その Connection プロパティはフォーム上の TFDConnection を指すように自動的に設定されます。
パラメータ化クエリの作成
パラメータ化クエリを作成するには、以下の構文を使用します:
FDQuery1->SQL->Text = "select * from Team where key = :key";
FDQuery1->ParamByName("key")->AsString = "ENG";
FDQuery1->Open();
上記の例では、文字列型の入力パラメータを名前でバインドし、結果のデータセットを開いています。
ステートメントの準備
ステートメントの準備は、システムリソースと時間の両方でコストがかかります。ステートメントの準備中は、接続がアクティブで開いている必要があります。デフォルトでは、FireDAC は同じクエリを何度もコンパイルすることを避けるためにクエリを準備します。ステートメントの準備を無効にするには、ResourceOptions.DirectExecute を True に設定します。例えば、クエリを一度だけ実行する必要がある場合などです。
クエリの実行
SELECT クエリなど、結果セットを返すクエリを実行するには、Open メソッドを使用します。Open メソッドはクエリを実行し、結果セットを返して開きます。クエリが結果セットを生成しない場合、Open メソッドはエラーを返します。
FDQuery1->SQL->Text = "select * from Team where key = :key";
FDQuery1->ParamByName("key")->AsString = "ENG";
FDQuery1->Open();
関連記事
以下に、RAD Studio、Delphi、C++ Builder で CData ODBC ドライバーを使用するための他の記事を紹介します。