Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →DataBind Controls to Amazon Athena Data in C++Builder
DataBind to Amazon Athena data in C++Builder with standard components and controls.
The CData ODBC Driver for Amazon Athena makes it easy to integrate connectivity to live Amazon Athena 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 Amazon Athena 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 Amazon Athena 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.
Authenticating to Amazon Athena
To authorize Amazon Athena requests, provide the credentials for an administrator account or for an IAM user with custom permissions: Set AccessKey to the access key Id. Set SecretKey to the secret access key.
Note: Though you can connect as the AWS account administrator, it is recommended to use IAM user credentials to access AWS services.
Obtaining the Access Key
To obtain the credentials for an IAM user, follow the steps below:
- Sign into the IAM console.
- In the navigation pane, select Users.
- To create or manage the access keys for a user, select the user and then select the Security Credentials tab.
To obtain the credentials for your AWS root account, follow the steps below:
- Sign into the AWS Management console with the credentials for your root account.
- Select your account name or number and select My Security Credentials in the menu that is displayed.
- Click Continue to Security Credentials and expand the Access Keys section to manage or create root account access keys.
Authenticating from an EC2 Instance
If you are using the CData Data Provider for Amazon Athena 2018 from an EC2 Instance and have an IAM Role assigned to the instance, you can use the IAM Role to authenticate. To do so, set UseEC2Roles to true and leave AccessKey and SecretKey empty. The CData Data Provider for Amazon Athena 2018 will automatically obtain your IAM Role credentials and authenticate with them.
Authenticating as an AWS Role
In many situations it may be preferable to use an IAM role for authentication instead of the direct security credentials of an AWS root user. An AWS role may be used instead by specifying the RoleARN. This will cause the CData Data Provider for Amazon Athena 2018 to attempt to retrieve credentials for the specified role. If you are connecting to AWS (instead of already being connected such as on an EC2 instance), you must additionally specify the AccessKey and SecretKey of an IAM user to assume the role for. Roles may not be used when specifying the AccessKey and SecretKey of an AWS root user.
Authenticating with MFA
For users and roles that require Multi-factor Authentication, specify the MFASerialNumber and MFAToken connection properties. This will cause the CData Data Provider for Amazon Athena 2018 to submit the MFA credentials in a request to retrieve temporary authentication credentials. Note that the duration of the temporary credentials may be controlled via the TemporaryTokenDuration (default 3600 seconds).
Connecting to Amazon Athena
In addition to the AccessKey and SecretKey properties, specify Database, S3StagingDirectory and Region. Set Region to the region where your Amazon Athena data is hosted. Set S3StagingDirectory to a folder in S3 where you would like to store the results of queries.
If Database is not set in the connection, the data provider connects to the default database set in Amazon Athena.
You can then follow the steps below to use the Data Explorer to create a FireDAC connection to Amazon Athena.
- 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 Amazon Athena.
Create VCL Applications with Connectivity to Amazon Athena Data
Follow the procedure below to start querying Amazon Athena 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 Amazon Athena.
- 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 Name, TotalDue FROM Customers
- 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 Amazon Athena with FireDAC Components
You can use the TFDConnection and TFQuery components to execute queries to Amazon Athena data. This section provides Amazon Athena-specific examples of executing queries with the TFQuery component.
Connect to Amazon Athena 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 Amazon Athena ODBC Source";
FDConnection1->Connected = true;
To connect the TFDQuery component to Amazon Athena 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 Customers where customerid = :CustomerId";
FDQuery1->ParamByName("customerid")->AsString = "12345";
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 Customers where customerid = :CustomerId";
FDQuery1->ParamByName("customerid")->AsString = "12345";
FDQuery1->Open();
To execute a query that does not return a result set, use the ExecSQL method. The ExecSQL method will return an error if the query returns a result set. To retrieve the count of affected rows use the TFD.RowsAffected property.
FDQuery1->SQL->Text = "delete from Customers where Id = :Id";
FDQuery1->Params->Items[0]->AsString = "x12345";
FDQuery1->ExecSQL();
AnsiString i = FDQuery1->RowsAffected;
ShowMessage("Rows affected: " + i);
Related Articles
Below you can find other articles for using the CData ODBC Driver with RAD Studio, Delphi, and C++ Builder.