Natively Connect to Amazon Athena Data in PHP

Drop the CData ODBC Driver for Amazon Athena into your LAMP or WAMP stack to build Amazon Athena-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Amazon Athena data, execute queries, and output the results.

Getting Started

---

Configure a DSN

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 to the access key Id. Set 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:

1. Sign into the IAM console.
2. In the navigation pane, select Users.
3. 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:

1. Sign into the AWS Management console with the credentials for your root account.
2. Select your account name or number and select My Security Credentials in the menu that is displayed.
3. 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 to true and leave and 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 . 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 and of an IAM user to assume the role for. Roles may not be used when specifying the and of an AWS root user.

Authenticating with MFA

For users and roles that require Multi-factor Authentication, specify the and 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 (default 3600 seconds).

Connecting to Amazon Athena

In addition to the and properties, specify , and . Set to the region where your Amazon Athena data is hosted. Set to a folder in S3 where you would like to store the results of queries.

If is not set in the connection, the data provider connects to the default database set in Amazon Athena.

Establish a Connection

Open the connection to Amazon Athena by calling the or methods. To close connections, use or .

$conn = odbc_connect("CData ODBC AmazonAthena Source","user","password");

Connections opened with are closed when the script ends. Connections opened with the method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources, and queries execute faster.

$conn = odbc_pconnect("CData ODBC AmazonAthena Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the function.

$query = odbc_prepare($conn, "SELECT * FROM Customers WHERE CustomerId = ?");

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC AmazonAthena Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Customers WHERE CustomerId = ?");
$success = odbc_execute($query, array('12345'));
 

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC AmazonAthena Source","user","password");
$query = odbc_exec($conn, "SELECT Name, TotalDue FROM Customers");
 

Process Results

Access a row in the result set as an array with the function.

$conn = odbc_connect("CData ODBC Amazon Athena data Source","user","password");
$query = odbc_exec($conn, "SELECT Name, TotalDue FROM Customers");
while($row = odbc_fetch_array($query)){
 echo $row["Name"] . "\n";
}

Display the result set in an HTML table with the function.

$conn = odbc_connect("CData ODBC Amazon Athena data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Customers WHERE CustomerId = ?");
$success = odbc_execute($query, array('12345'));
if($success)
 odbc_result_all($query);

More Example Queries

You will find complete information on the driver's supported SQL in the help documentation. The code examples above are Amazon Athena-specific adaptations of the PHP community documentation for all ODBC functions.