Ready to get started?

Learn more about the CData JDBC Driver for Amazon S3 or download a free trial:

Download Now

Query Amazon S3 Data in ColdFusion

Write standard ColdFusion data access code to connect to Amazon S3 data.

The CData JDBC Driver for Amazon S3 seamlessly integrates connectivity to Amazon S3 data with the rapid development tools in ColdFusion. This article shows how to connect to Amazon S3 data in ColdFusion and query Amazon S3 tables.

Create a JDBC Data Source for Amazon S3 in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

  1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

    The JAR and license for the driver are located in the lib subfolder of the installation directory.

    Restart the server after this step.

  2. Add the driver as a data source:

    From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

  3. Populate the driver properties:

    • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:amazons3: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

      To authorize Amazon S3 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: You can connect as the AWS account administrator, but it is recommended to use IAM user credentials to access AWS services.

      For information on obtaining the credentials and other authentication methods, refer to the Getting Started section of the Help documentation.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Amazon S3 JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.amazons3.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      A typical JDBC URL is below:

      jdbc:amazons3:AccessKey=a123;SecretKey=s123;
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.amazons3.AmazonS3Driver.
    • Driver Name: Enter a user-defined name for the driver.
    • Username: Enter the username used to authenticate.
    • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData Amazon S3 data source in the Actions column. After reporting a status of OK, the Amazon S3 data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to Amazon S3. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

<cfquery name="AmazonS3Query" dataSource="CDataAmazonS3"> SELECT * FROM ObjectsACL WHERE Name = <cfqueryparam value="#Name#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#AmazonS3Query#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM ObjectsACL WHERE Name = ?", 
  [
    { value="TestBucket", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataAmazonS3" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following:

http://MyServer:8500/query.cfm?Name=TestBucket