C++Builder でLakebase のデータにデータバインドするコントロールを作成
CData ODBC ドライバー for Lakebase を使用すると、C++Builder の標準データアクセスコンポーネントを使ってライブのLakebase のデータ への接続を簡単に統合できます。この記事では、C++Builder でシンプルな VCL(Visual Component Library)アプリケーションを作成し、Lakebase のデータ に接続してクエリを実行し、グリッドに結果を表示する方法を説明します。さらに、FireDAC コンポーネントを使ってコードからコマンドを実行する方法も紹介します。
Lakebase のデータへの接続を作成
まだ設定していない場合は、ODBC DSN(データソース名)で接続プロパティを指定します。これはドライバーインストールの最終ステップです。Microsoft ODBC データソースアドミニストレーターを使って ODBC DSN を作成・設定できます。
Databricks Lakebase に接続するには、以下のプロパティを設定します。
- DatabricksInstance: Databricks インスタンスまたはサーバーホスト名を指定します。形式は instance-abcdef12-3456-7890-abcd-abcdef123456.database.cloud.databricks.com です。
- Server: Lakebase データベースをホストするサーバーのホスト名または IP アドレスを指定します。
- Port(オプション): Lakebase データベースをホストするサーバーのポート番号を指定します。デフォルトは 5432 です。
- Database(オプション): Lakebase サーバーへの認証後に接続するデータベースを指定します。デフォルトでは認証ユーザーのデフォルトデータベースに接続します。
OAuth クライアント認証
OAuth クライアント資格情報を使用して認証するには、サービスプリンシパルで OAuth クライアントを構成します。手順の概要は以下のとおりです。
- 新しいサービスプリンシパルを作成・構成する
- サービスプリンシパルに権限を割り当てる
- サービスプリンシパル用の OAuth シークレットを作成する
詳細については、ヘルプドキュメントの「Setting Up OAuthClient Authentication」セクションをご参照ください。
OAuth PKCE 認証
PKCE(Proof Key for Code Exchange)を使用した OAuth code タイプで認証するには、以下のプロパティを設定します。
- AuthScheme: OAuthPKCE を指定します。
- User: 認証ユーザーのユーザー ID を指定します。
詳細については、ヘルプドキュメントをご参照ください。
次に、以下の手順に従って Data Explorer を使用し、Lakebase への FireDAC 接続を作成します。
- 新しい VCL Forms アプリケーションで、Data Explorer の FireDAC ノードを展開します。
- Data Explorer の ODBC Data Source ノードを右クリックします。
- Add New Connection をクリックします。
- 接続の名前を入力します。
- 表示される FireDAC Connection Editor で、DataSource プロパティをLakebase の ODBC DSN の名前に設定します。
Lakebase のデータに接続する VCL アプリケーションを作成
以下の手順に従って、クエリの結果をグリッドに表示するシンプルな VCL アプリケーションからLakebase のデータ のクエリを開始します。
-
TFDConnection コンポーネントをフォームにドロップし、以下のプロパティを設定します:
- ConnectionDefName:Lakebase への FireDAC 接続を選択します。
- Connected:メニューから True を選択し、表示されるダイアログで資格情報を入力します。
-
TFDQuery コンポーネントをフォームにドロップし、以下のプロパティを設定します:
- Connection:TFDConnection コンポーネントに設定します(まだ指定されていない場合)。
SQL:SQL プロパティのボタンをクリックし、クエリを入力します。例:
SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'
- Active:このプロパティを true に設定します。
TDataSource コンポーネントをフォームにドロップし、以下のプロパティを設定します:
- DataSet:このプロパティのメニューで、TFDQuery コンポーネントの名前を選択します。
-
TDBGrid コントロールをフォームにドロップし、以下のプロパティを設定します:
- DataSource:TDataSource の名前を選択します。
- TFDGUIxWaitCursor をフォームにドロップします — これは実行時エラーを回避するために必要です。
FireDAC コンポーネントを使ってLakebase にコマンドを実行
TFDConnection および TFQuery コンポーネントを使用して、Lakebase のデータ にクエリを実行できます。このセクションでは、TFQuery コンポーネントを使ったクエリ実行のLakebase 固有の例を紹介します。
Lakebase のデータに接続
データソースに接続するには、TFDConnection コンポーネントの Connected プロパティを true に設定します。コードから同じプロパティを設定することもできます:
FDConnection1->ConnectionDefName = "CData Lakebase ODBC Source"; FDConnection1->Connected = true;
TFDQuery コンポーネントをLakebase のデータ に接続するには、コンポーネントの Connection プロパティを設定します。設計時に TFDQuery コンポーネントを追加すると、上記のアプリケーションのように、その Connection プロパティはフォーム上の TFDConnection を指すように自動的に設定されます。
パラメータ化クエリの作成
パラメータ化クエリを作成するには、以下の構文を使用します:
FDQuery1->SQL->Text = "select * from Orders where shipcountry = :ShipCountry";
FDQuery1->ParamByName("shipcountry")->AsString = "USA";
FDQuery1->Open();
上記の例では、文字列型の入力パラメータを名前でバインドし、結果のデータセットを開いています。
ステートメントの準備
ステートメントの準備は、システムリソースと時間の両方でコストがかかります。ステートメントの準備中は、接続がアクティブで開いている必要があります。デフォルトでは、FireDAC は同じクエリを何度もコンパイルすることを避けるためにクエリを準備します。ステートメントの準備を無効にするには、ResourceOptions.DirectExecute を True に設定します。例えば、クエリを一度だけ実行する必要がある場合などです。
クエリの実行
SELECT クエリなど、結果セットを返すクエリを実行するには、Open メソッドを使用します。Open メソッドはクエリを実行し、結果セットを返して開きます。クエリが結果セットを生成しない場合、Open メソッドはエラーを返します。
FDQuery1->SQL->Text = "select * from Orders where shipcountry = :ShipCountry";
FDQuery1->ParamByName("shipcountry")->AsString = "USA";
FDQuery1->Open();
結果セットを返さないクエリを実行するには、ExecSQL メソッドを使用します。クエリが結果セットを返す場合、ExecSQL メソッドはエラーを返します。影響を受けた行数を取得するには、TFD.RowsAffected プロパティを使用します。
FDQuery1->SQL->Text = "delete from Orders where Id = :Id";
FDQuery1->Params->Items[0]->AsString = "x12345";
FDQuery1->ExecSQL();
AnsiString i = FDQuery1->RowsAffected;
ShowMessage("Rows affected: " + i);
関連記事
以下に、RAD Studio、Delphi、C++ Builder で CData ODBC ドライバーを使用するための他の記事を紹介します。