Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →DataBind Controls to IBM Cloud Object Storage Data in C++Builder
DataBind to IBM Cloud Object Storage data in C++Builder with standard components and controls.
The CData ODBC driver for IBM Cloud Object Storage makes it easy to integrate connectivity to live IBM Cloud Object Storage data with standard data access components in C++Builder. This article shows how to create a simple visual component library (VCL) application in C++Builder that connects to IBM Cloud Object Storage data, executes queries, and displays the results in a grid. An additional section shows how to use FireDAC components to execute commands from code.
Create a Connection to IBM Cloud Object Storage Data
If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.
Register a New Instance of Cloud Object Storage
If you do not already have Cloud Object Storage in your IBM Cloud account, follow the procedure below to install an instance of SQL Query in your account:
- Log in to your IBM Cloud account.
- Navigate to the page, choose a name for your instance and click Create. You will be redirected to the instance of Cloud Object Storage you just created.
Connecting using OAuth Authentication
There are certain connection properties you need to set before you can connect. You can obtain these as follows:
API Key
To connect with IBM Cloud Object Storage, you need an API Key. You can obtain this as follows:
- Log in to your IBM Cloud account.
- Navigate to the Platform API Keys page.
- On the middle-right corner click "Create an IBM Cloud API Key" to create a new API Key.
- In the pop-up window, specify the API Key name and click "Create". Note the API Key as you can never access it again from the dashboard.
Cloud Object Storage CRN
If you have multiple accounts, you will need to specify the CloudObjectStorageCRN explicitly. To find the appropriate value, you can:
- Query the Services view. This will list your IBM Cloud Object Storage instances along with the CRN for each.
- Locate the CRN directly in IBM Cloud. To do so, navigate to your IBM Cloud Dashboard. In the Resource List, Under Storage, select your Cloud Object Storage resource to get its CRN.
Connecting to Data
You can now set the following to connect to data:
- InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
- ApiKey: Set this to your API key which was noted during setup.
- CloudObjectStorageCRN (Optional): Set this to the cloud object storage CRN you want to work with. While the connector attempts to retrieve this automatically, specifying this explicitly is recommended if you have more than Cloud Object Storage account.
When you connect, the connector completes the OAuth process.
- Extracts the access token and authenticates requests.
- Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
You can then follow the steps below to use the Data Explorer to create a FireDAC connection to IBM Cloud Object Storage.
- In a new VCL Forms application, expand the FireDAC node in the Data Explorer.
- Right-click the ODBC Data Source node in the Data Explorer.
- Click Add New Connection.
- Enter a name for the connection.
- In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for IBM Cloud Object Storage.
Create VCL Applications with Connectivity to IBM Cloud Object Storage Data
Follow the procedure below to start querying IBM Cloud Object Storage data from a simple VCL application that displays the results of a query in a grid.
-
Drop a TFDConnection component onto the form and set the following properties:
- ConnectionDefName: Select the FireDAC connection to IBM Cloud Object Storage.
- Connected: Select True from the menu and, in the dialog that appears, enter your credentials.
-
Drop a TFDQuery component onto the form and set the properties below:
- Connection: Set this property to the TFDConnection component, if this component is not already specified.
SQL: Click the button in the SQL property and enter a query. For example:
SELECT Key, Etag FROM Objects WHERE Bucket = 'someBucket'
- Active: Set this property to true.
Drop a TDataSource component onto the form and set the following property:
- DataSet: In the menu for this property, select the name of the TFDQuery component.
-
Drop a TDBGrid control onto the form and set the following property:
- DataSource: Select the name of the TDataSource.
- Drop a TFDGUIxWaitCursor onto the form — this is required to avoid a run-time error.
Execute Commands to IBM Cloud Object Storage with FireDAC Components
You can use the TFDConnection and TFQuery components to execute queries to IBM Cloud Object Storage data. This section provides IBM Cloud Object Storage-specific examples of executing queries with the TFQuery component.
Connect to IBM Cloud Object Storage Data
To connect to the data source, set the Connected property of the TFDConnection component to true. You can set the same properties from code:
FDConnection1->ConnectionDefName = "CData IBM Cloud Object Storage ODBC Source";
FDConnection1->Connected = true;
To connect the TFDQuery component to IBM Cloud Object Storage data, set the Connection property of the component. When a TFDQuery component is added at design time, its Connection property is automatically set to point to a TFDConnection on the form, as in the application above.
Create Parameterized Queries
To create a parameterized query, use the following syntax below:
FDQuery1->SQL->Text = "select * from Objects where bucket = :Bucket";
FDQuery1->ParamByName("bucket")->AsString = "someBucket";
FDQuery1->Open();
The example above binds a string-type input parameter by name and then opens the dataset that results.
Prepare the Statement
Preparing statements is costly in system resources and time. The connection must be active and open while a statement is prepared. By default, FireDAC prepares the query to avoid recompiling the same query over and over. To disable statement preparation, set ResourceOptions.DirectExecute to True; for example, when you need to execute a query only once.
Execute a Query
To execute a query that returns a result set, such as a select query, use the Open method. The Open method executes the query, returns the result set, and opens it. The Open method will return an error if the query does not produce a result set.
FDQuery1->SQL->Text = "select * from Objects where bucket = :Bucket";
FDQuery1->ParamByName("bucket")->AsString = "someBucket";
FDQuery1->Open();
Related Articles
Below you can find other articles for using the CData ODBC Driver with RAD Studio, Delphi, and C++ Builder.